1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
45 #include <acpi/acparser.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acdispat.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acinterp.h>
51 #define _COMPONENT ACPI_DISPATCHER
52 ACPI_MODULE_NAME("dsobject")
54 /* Local prototypes */
56 acpi_ds_build_internal_object(struct acpi_walk_state *walk_state,
57 union acpi_parse_object *op,
58 union acpi_operand_object **obj_desc_ptr);
60 #ifndef ACPI_NO_METHOD_EXECUTION
61 /*******************************************************************************
63 * FUNCTION: acpi_ds_build_internal_object
65 * PARAMETERS: walk_state - Current walk state
66 * Op - Parser object to be translated
67 * obj_desc_ptr - Where the ACPI internal object is returned
71 * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
72 * Simple objects are any objects other than a package object!
74 ******************************************************************************/
77 acpi_ds_build_internal_object(struct acpi_walk_state *walk_state,
78 union acpi_parse_object *op,
79 union acpi_operand_object **obj_desc_ptr)
81 union acpi_operand_object *obj_desc;
84 ACPI_FUNCTION_TRACE(ds_build_internal_object);
87 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
89 * This is a named object reference. If this name was
90 * previously looked up in the namespace, it was stored in this op.
91 * Otherwise, go ahead and look it up now
93 if (!op->common.node) {
94 status = acpi_ns_lookup(walk_state->scope_info,
95 op->common.value.string,
98 ACPI_NS_SEARCH_PARENT |
99 ACPI_NS_DONT_OPEN_SCOPE, NULL,
100 ACPI_CAST_INDIRECT_PTR(struct
105 if (ACPI_FAILURE(status)) {
107 /* Check if we are resolving a named reference within a package */
109 if ((status == AE_NOT_FOUND)
110 && (acpi_gbl_enable_interpreter_slack)
112 ((op->common.parent->common.aml_opcode ==
114 || (op->common.parent->common.aml_opcode ==
115 AML_VAR_PACKAGE_OP))) {
117 * We didn't find the target and we are populating elements
118 * of a package - ignore if slack enabled. Some ASL code
119 * contains dangling invalid references in packages and
120 * expects that no exception will be issued. Leave the
121 * element as a null element. It cannot be used, but it
122 * can be overwritten by subsequent ASL code - this is
123 * typically the case.
125 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
126 "Ignoring unresolved reference in package [%4.4s]\n",
131 return_ACPI_STATUS(AE_OK);
133 ACPI_ERROR_NAMESPACE(op->common.value.
137 return_ACPI_STATUS(status);
141 /* Special object resolution for elements of a package */
143 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
144 (op->common.parent->common.aml_opcode ==
145 AML_VAR_PACKAGE_OP)) {
147 * Attempt to resolve the node to a value before we insert it into
148 * the package. If this is a reference to a common data type,
149 * resolve it immediately. According to the ACPI spec, package
150 * elements can only be "data objects" or method references.
151 * Attempt to resolve to an Integer, Buffer, String or Package.
152 * If cannot, return the named reference (for things like Devices,
153 * Methods, etc.) Buffer Fields and Fields will resolve to simple
154 * objects (int/buf/str/pkg).
156 * NOTE: References to things like Devices, Methods, Mutexes, etc.
157 * will remain as named references. This behavior is not described
158 * in the ACPI spec, but it appears to be an oversight.
160 obj_desc = (union acpi_operand_object *)op->common.node;
163 acpi_ex_resolve_node_to_value(ACPI_CAST_INDIRECT_PTR
168 if (ACPI_FAILURE(status)) {
169 return_ACPI_STATUS(status);
172 switch (op->common.node->type) {
174 * For these types, we need the actual node, not the subobject.
175 * However, the subobject did not get an extra reference count above.
177 * TBD: should ex_resolve_node_to_value be changed to fix this?
179 case ACPI_TYPE_DEVICE:
180 case ACPI_TYPE_THERMAL:
182 acpi_ut_add_reference(op->common.node->object);
184 /*lint -fallthrough */
186 * For these types, we need the actual node, not the subobject.
187 * The subobject got an extra reference count in ex_resolve_node_to_value.
189 case ACPI_TYPE_MUTEX:
190 case ACPI_TYPE_METHOD:
191 case ACPI_TYPE_POWER:
192 case ACPI_TYPE_PROCESSOR:
193 case ACPI_TYPE_EVENT:
194 case ACPI_TYPE_REGION:
196 /* We will create a reference object for these types below */
201 * All other types - the node was resolved to an actual
202 * object, we are done.
209 /* Create and init a new internal ACPI object */
211 obj_desc = acpi_ut_create_internal_object((acpi_ps_get_opcode_info
212 (op->common.aml_opcode))->
215 return_ACPI_STATUS(AE_NO_MEMORY);
219 acpi_ds_init_object_from_op(walk_state, op, op->common.aml_opcode,
221 if (ACPI_FAILURE(status)) {
222 acpi_ut_remove_reference(obj_desc);
223 return_ACPI_STATUS(status);
227 *obj_desc_ptr = obj_desc;
228 return_ACPI_STATUS(status);
231 /*******************************************************************************
233 * FUNCTION: acpi_ds_build_internal_buffer_obj
235 * PARAMETERS: walk_state - Current walk state
236 * Op - Parser object to be translated
237 * buffer_length - Length of the buffer
238 * obj_desc_ptr - Where the ACPI internal object is returned
242 * DESCRIPTION: Translate a parser Op package object to the equivalent
245 ******************************************************************************/
248 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
249 union acpi_parse_object *op,
251 union acpi_operand_object **obj_desc_ptr)
253 union acpi_parse_object *arg;
254 union acpi_operand_object *obj_desc;
255 union acpi_parse_object *byte_list;
256 u32 byte_list_length = 0;
258 ACPI_FUNCTION_TRACE(ds_build_internal_buffer_obj);
261 * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
262 * The buffer object already exists (from the NS node), otherwise it must
265 obj_desc = *obj_desc_ptr;
268 /* Create a new buffer object */
270 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
271 *obj_desc_ptr = obj_desc;
273 return_ACPI_STATUS(AE_NO_MEMORY);
278 * Second arg is the buffer data (optional) byte_list can be either
279 * individual bytes or a string initializer. In either case, a
280 * byte_list appears in the AML.
282 arg = op->common.value.arg; /* skip first arg */
284 byte_list = arg->named.next;
286 if (byte_list->common.aml_opcode != AML_INT_BYTELIST_OP) {
288 "Expecting bytelist, got AML opcode %X in op %p",
289 byte_list->common.aml_opcode, byte_list));
291 acpi_ut_remove_reference(obj_desc);
295 byte_list_length = (u32) byte_list->common.value.integer;
299 * The buffer length (number of bytes) will be the larger of:
300 * 1) The specified buffer length and
301 * 2) The length of the initializer byte list
303 obj_desc->buffer.length = buffer_length;
304 if (byte_list_length > buffer_length) {
305 obj_desc->buffer.length = byte_list_length;
308 /* Allocate the buffer */
310 if (obj_desc->buffer.length == 0) {
311 obj_desc->buffer.pointer = NULL;
312 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
313 "Buffer defined with zero length in AML, creating\n"));
315 obj_desc->buffer.pointer =
316 ACPI_ALLOCATE_ZEROED(obj_desc->buffer.length);
317 if (!obj_desc->buffer.pointer) {
318 acpi_ut_delete_object_desc(obj_desc);
319 return_ACPI_STATUS(AE_NO_MEMORY);
322 /* Initialize buffer from the byte_list (if present) */
325 ACPI_MEMCPY(obj_desc->buffer.pointer,
326 byte_list->named.data, byte_list_length);
330 obj_desc->buffer.flags |= AOPOBJ_DATA_VALID;
331 op->common.node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_desc);
332 return_ACPI_STATUS(AE_OK);
335 /*******************************************************************************
337 * FUNCTION: acpi_ds_build_internal_package_obj
339 * PARAMETERS: walk_state - Current walk state
340 * Op - Parser object to be translated
341 * element_count - Number of elements in the package - this is
342 * the num_elements argument to Package()
343 * obj_desc_ptr - Where the ACPI internal object is returned
347 * DESCRIPTION: Translate a parser Op package object to the equivalent
350 * NOTE: The number of elements in the package will be always be the num_elements
351 * count, regardless of the number of elements in the package list. If
352 * num_elements is smaller, only that many package list elements are used.
353 * if num_elements is larger, the Package object is padded out with
354 * objects of type Uninitialized (as per ACPI spec.)
356 * Even though the ASL compilers do not allow num_elements to be smaller
357 * than the Package list length (for the fixed length package opcode), some
358 * BIOS code modifies the AML on the fly to adjust the num_elements, and
359 * this code compensates for that. This also provides compatibility with
360 * other AML interpreters.
362 ******************************************************************************/
365 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
366 union acpi_parse_object *op,
368 union acpi_operand_object **obj_desc_ptr)
370 union acpi_parse_object *arg;
371 union acpi_parse_object *parent;
372 union acpi_operand_object *obj_desc = NULL;
373 acpi_status status = AE_OK;
378 ACPI_FUNCTION_TRACE(ds_build_internal_package_obj);
380 /* Find the parent of a possibly nested package */
382 parent = op->common.parent;
383 while ((parent->common.aml_opcode == AML_PACKAGE_OP) ||
384 (parent->common.aml_opcode == AML_VAR_PACKAGE_OP)) {
385 parent = parent->common.parent;
389 * If we are evaluating a Named package object "Name (xxxx, Package)",
390 * the package object already exists, otherwise it must be created.
392 obj_desc = *obj_desc_ptr;
394 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
395 *obj_desc_ptr = obj_desc;
397 return_ACPI_STATUS(AE_NO_MEMORY);
400 obj_desc->package.node = parent->common.node;
404 * Allocate the element array (array of pointers to the individual
405 * objects) based on the num_elements parameter. Add an extra pointer slot
406 * so that the list is always null terminated.
408 obj_desc->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
410 1) * sizeof(void *));
412 if (!obj_desc->package.elements) {
413 acpi_ut_delete_object_desc(obj_desc);
414 return_ACPI_STATUS(AE_NO_MEMORY);
417 obj_desc->package.count = element_count;
420 * Initialize the elements of the package, up to the num_elements count.
421 * Package is automatically padded with uninitialized (NULL) elements
422 * if num_elements is greater than the package list length. Likewise,
423 * Package is truncated if num_elements is less than the list length.
425 arg = op->common.value.arg;
426 arg = arg->common.next;
427 for (i = 0; arg && (i < element_count); i++) {
428 if (arg->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
429 if (arg->common.node->type == ACPI_TYPE_METHOD) {
431 * A method reference "looks" to the parser to be a method
432 * invocation, so we special case it here
434 arg->common.aml_opcode = AML_INT_NAMEPATH_OP;
436 acpi_ds_build_internal_object(walk_state,
442 /* This package element is already built, just get it */
444 obj_desc->package.elements[i] =
445 ACPI_CAST_PTR(union acpi_operand_object,
449 status = acpi_ds_build_internal_object(walk_state, arg,
457 /* Existing package, get existing reference count */
460 (*obj_desc_ptr)->common.reference_count;
461 if (reference_count > 1) {
463 /* Make new element ref count match original ref count */
465 for (index = 0; index < (reference_count - 1);
467 acpi_ut_add_reference((obj_desc->
474 arg = arg->common.next;
478 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
479 "Package List length larger than NumElements count (%X), truncated\n",
483 obj_desc->package.flags |= AOPOBJ_DATA_VALID;
484 op->common.node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_desc);
485 return_ACPI_STATUS(status);
488 /*******************************************************************************
490 * FUNCTION: acpi_ds_create_node
492 * PARAMETERS: walk_state - Current walk state
493 * Node - NS Node to be initialized
494 * Op - Parser object to be translated
498 * DESCRIPTION: Create the object to be associated with a namespace node
500 ******************************************************************************/
503 acpi_ds_create_node(struct acpi_walk_state *walk_state,
504 struct acpi_namespace_node *node,
505 union acpi_parse_object *op)
508 union acpi_operand_object *obj_desc;
510 ACPI_FUNCTION_TRACE_PTR(ds_create_node, op);
513 * Because of the execution pass through the non-control-method
514 * parts of the table, we can arrive here twice. Only init
515 * the named object node the first time through
517 if (acpi_ns_get_attached_object(node)) {
518 return_ACPI_STATUS(AE_OK);
521 if (!op->common.value.arg) {
523 /* No arguments, there is nothing to do */
525 return_ACPI_STATUS(AE_OK);
528 /* Build an internal object for the argument(s) */
530 status = acpi_ds_build_internal_object(walk_state, op->common.value.arg,
532 if (ACPI_FAILURE(status)) {
533 return_ACPI_STATUS(status);
536 /* Re-type the object according to its argument */
538 node->type = ACPI_GET_OBJECT_TYPE(obj_desc);
540 /* Attach obj to node */
542 status = acpi_ns_attach_object(node, obj_desc, node->type);
544 /* Remove local reference to the object */
546 acpi_ut_remove_reference(obj_desc);
547 return_ACPI_STATUS(status);
550 #endif /* ACPI_NO_METHOD_EXECUTION */
552 /*******************************************************************************
554 * FUNCTION: acpi_ds_init_object_from_op
556 * PARAMETERS: walk_state - Current walk state
557 * Op - Parser op used to init the internal object
558 * Opcode - AML opcode associated with the object
559 * ret_obj_desc - Namespace object to be initialized
563 * DESCRIPTION: Initialize a namespace object from a parser Op and its
564 * associated arguments. The namespace object is a more compact
565 * representation of the Op and its arguments.
567 ******************************************************************************/
570 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
571 union acpi_parse_object *op,
573 union acpi_operand_object **ret_obj_desc)
575 const struct acpi_opcode_info *op_info;
576 union acpi_operand_object *obj_desc;
577 acpi_status status = AE_OK;
579 ACPI_FUNCTION_TRACE(ds_init_object_from_op);
581 obj_desc = *ret_obj_desc;
582 op_info = acpi_ps_get_opcode_info(opcode);
583 if (op_info->class == AML_CLASS_UNKNOWN) {
587 return_ACPI_STATUS(AE_TYPE);
590 /* Perform per-object initialization */
592 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
593 case ACPI_TYPE_BUFFER:
596 * Defer evaluation of Buffer term_arg operand
598 obj_desc->buffer.node =
599 ACPI_CAST_PTR(struct acpi_namespace_node,
600 walk_state->operands[0]);
601 obj_desc->buffer.aml_start = op->named.data;
602 obj_desc->buffer.aml_length = op->named.length;
605 case ACPI_TYPE_PACKAGE:
608 * Defer evaluation of Package term_arg operand
610 obj_desc->package.node =
611 ACPI_CAST_PTR(struct acpi_namespace_node,
612 walk_state->operands[0]);
613 obj_desc->package.aml_start = op->named.data;
614 obj_desc->package.aml_length = op->named.length;
617 case ACPI_TYPE_INTEGER:
619 switch (op_info->type) {
620 case AML_TYPE_CONSTANT:
622 * Resolve AML Constants here - AND ONLY HERE!
623 * All constants are integers.
624 * We mark the integer with a flag that indicates that it started
625 * life as a constant -- so that stores to constants will perform
626 * as expected (noop). zero_op is used as a placeholder for optional
629 obj_desc->common.flags = AOPOBJ_AML_CONSTANT;
634 obj_desc->integer.value = 0;
639 obj_desc->integer.value = 1;
644 obj_desc->integer.value = ACPI_INTEGER_MAX;
646 /* Truncate value if we are executing from a 32-bit ACPI table */
648 #ifndef ACPI_NO_METHOD_EXECUTION
649 acpi_ex_truncate_for32bit_table(obj_desc);
653 case AML_REVISION_OP:
655 obj_desc->integer.value = ACPI_CA_VERSION;
661 "Unknown constant opcode %X",
663 status = AE_AML_OPERAND_TYPE;
668 case AML_TYPE_LITERAL:
670 obj_desc->integer.value = op->common.value.integer;
671 #ifndef ACPI_NO_METHOD_EXECUTION
672 acpi_ex_truncate_for32bit_table(obj_desc);
677 ACPI_ERROR((AE_INFO, "Unknown Integer type %X",
679 status = AE_AML_OPERAND_TYPE;
684 case ACPI_TYPE_STRING:
686 obj_desc->string.pointer = op->common.value.string;
687 obj_desc->string.length =
688 (u32) ACPI_STRLEN(op->common.value.string);
691 * The string is contained in the ACPI table, don't ever try
694 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
697 case ACPI_TYPE_METHOD:
700 case ACPI_TYPE_LOCAL_REFERENCE:
702 switch (op_info->type) {
703 case AML_TYPE_LOCAL_VARIABLE:
705 /* Split the opcode into a base opcode + offset */
707 obj_desc->reference.opcode = AML_LOCAL_OP;
708 obj_desc->reference.offset = opcode - AML_LOCAL_OP;
710 #ifndef ACPI_NO_METHOD_EXECUTION
711 status = acpi_ds_method_data_get_node(AML_LOCAL_OP,
722 case AML_TYPE_METHOD_ARGUMENT:
724 /* Split the opcode into a base opcode + offset */
726 obj_desc->reference.opcode = AML_ARG_OP;
727 obj_desc->reference.offset = opcode - AML_ARG_OP;
729 #ifndef ACPI_NO_METHOD_EXECUTION
730 status = acpi_ds_method_data_get_node(AML_ARG_OP,
741 default: /* Other literals, etc.. */
743 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
745 /* Node was saved in Op */
747 obj_desc->reference.node = op->common.node;
748 obj_desc->reference.object =
749 op->common.node->object;
752 obj_desc->reference.opcode = opcode;
759 ACPI_ERROR((AE_INFO, "Unimplemented data type: %X",
760 ACPI_GET_OBJECT_TYPE(obj_desc)));
762 status = AE_AML_OPERAND_TYPE;
766 return_ACPI_STATUS(status);