1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, 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)) {
106 /* Check if we are resolving a named reference within a package */
108 if ((status == AE_NOT_FOUND)
109 && (acpi_gbl_enable_interpreter_slack)
111 ((op->common.parent->common.aml_opcode ==
113 || (op->common.parent->common.aml_opcode ==
114 AML_VAR_PACKAGE_OP))) {
116 * We didn't find the target and we are populating elements
117 * of a package - ignore if slack enabled. Some ASL code
118 * contains dangling invalid references in packages and
119 * expects that no exception will be issued. Leave the
120 * element as a null element. It cannot be used, but it
121 * can be overwritten by subsequent ASL code - this is
122 * typically the case.
124 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
125 "Ignoring unresolved reference in package [%4.4s]\n",
130 return_ACPI_STATUS(AE_OK);
132 ACPI_REPORT_NSERROR(op->common.value.
136 return_ACPI_STATUS(status);
141 /* Create and init a new internal ACPI object */
143 obj_desc = acpi_ut_create_internal_object((acpi_ps_get_opcode_info
144 (op->common.aml_opcode))->
147 return_ACPI_STATUS(AE_NO_MEMORY);
151 acpi_ds_init_object_from_op(walk_state, op, op->common.aml_opcode,
153 if (ACPI_FAILURE(status)) {
154 acpi_ut_remove_reference(obj_desc);
155 return_ACPI_STATUS(status);
158 *obj_desc_ptr = obj_desc;
159 return_ACPI_STATUS(AE_OK);
162 /*******************************************************************************
164 * FUNCTION: acpi_ds_build_internal_buffer_obj
166 * PARAMETERS: walk_state - Current walk state
167 * Op - Parser object to be translated
168 * buffer_length - Length of the buffer
169 * obj_desc_ptr - Where the ACPI internal object is returned
173 * DESCRIPTION: Translate a parser Op package object to the equivalent
176 ******************************************************************************/
179 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
180 union acpi_parse_object *op,
182 union acpi_operand_object **obj_desc_ptr)
184 union acpi_parse_object *arg;
185 union acpi_operand_object *obj_desc;
186 union acpi_parse_object *byte_list;
187 u32 byte_list_length = 0;
189 ACPI_FUNCTION_TRACE("ds_build_internal_buffer_obj");
192 * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
193 * The buffer object already exists (from the NS node), otherwise it must
196 obj_desc = *obj_desc_ptr;
198 /* Create a new buffer object */
200 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
201 *obj_desc_ptr = obj_desc;
203 return_ACPI_STATUS(AE_NO_MEMORY);
208 * Second arg is the buffer data (optional) byte_list can be either
209 * individual bytes or a string initializer. In either case, a
210 * byte_list appears in the AML.
212 arg = op->common.value.arg; /* skip first arg */
214 byte_list = arg->named.next;
216 if (byte_list->common.aml_opcode != AML_INT_BYTELIST_OP) {
217 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
218 "Expecting bytelist, got AML opcode %X in op %p\n",
219 byte_list->common.aml_opcode,
222 acpi_ut_remove_reference(obj_desc);
226 byte_list_length = (u32) byte_list->common.value.integer;
230 * The buffer length (number of bytes) will be the larger of:
231 * 1) The specified buffer length and
232 * 2) The length of the initializer byte list
234 obj_desc->buffer.length = buffer_length;
235 if (byte_list_length > buffer_length) {
236 obj_desc->buffer.length = byte_list_length;
239 /* Allocate the buffer */
241 if (obj_desc->buffer.length == 0) {
242 obj_desc->buffer.pointer = NULL;
243 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
244 "Buffer defined with zero length in AML, creating\n"));
246 obj_desc->buffer.pointer =
247 ACPI_MEM_CALLOCATE(obj_desc->buffer.length);
248 if (!obj_desc->buffer.pointer) {
249 acpi_ut_delete_object_desc(obj_desc);
250 return_ACPI_STATUS(AE_NO_MEMORY);
253 /* Initialize buffer from the byte_list (if present) */
256 ACPI_MEMCPY(obj_desc->buffer.pointer,
257 byte_list->named.data, byte_list_length);
261 obj_desc->buffer.flags |= AOPOBJ_DATA_VALID;
262 op->common.node = (struct acpi_namespace_node *)obj_desc;
263 return_ACPI_STATUS(AE_OK);
266 /*******************************************************************************
268 * FUNCTION: acpi_ds_build_internal_package_obj
270 * PARAMETERS: walk_state - Current walk state
271 * Op - Parser object to be translated
272 * package_length - Number of elements in the package
273 * obj_desc_ptr - Where the ACPI internal object is returned
277 * DESCRIPTION: Translate a parser Op package object to the equivalent
280 ******************************************************************************/
283 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
284 union acpi_parse_object *op,
286 union acpi_operand_object **obj_desc_ptr)
288 union acpi_parse_object *arg;
289 union acpi_parse_object *parent;
290 union acpi_operand_object *obj_desc = NULL;
291 u32 package_list_length;
292 acpi_status status = AE_OK;
295 ACPI_FUNCTION_TRACE("ds_build_internal_package_obj");
297 /* Find the parent of a possibly nested package */
299 parent = op->common.parent;
300 while ((parent->common.aml_opcode == AML_PACKAGE_OP) ||
301 (parent->common.aml_opcode == AML_VAR_PACKAGE_OP)) {
302 parent = parent->common.parent;
306 * If we are evaluating a Named package object "Name (xxxx, Package)",
307 * the package object already exists, otherwise it must be created.
309 obj_desc = *obj_desc_ptr;
311 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
312 *obj_desc_ptr = obj_desc;
314 return_ACPI_STATUS(AE_NO_MEMORY);
317 obj_desc->package.node = parent->common.node;
320 obj_desc->package.count = package_length;
322 /* Count the number of items in the package list */
324 arg = op->common.value.arg;
325 arg = arg->common.next;
326 for (package_list_length = 0; arg; package_list_length++) {
327 arg = arg->common.next;
331 * The package length (number of elements) will be the greater
332 * of the specified length and the length of the initializer list
334 if (package_list_length > package_length) {
335 obj_desc->package.count = package_list_length;
339 * Allocate the pointer array (array of pointers to the
340 * individual objects). Add an extra pointer slot so
341 * that the list is always null terminated.
343 obj_desc->package.elements = ACPI_MEM_CALLOCATE(((acpi_size) obj_desc->
345 1) * sizeof(void *));
347 if (!obj_desc->package.elements) {
348 acpi_ut_delete_object_desc(obj_desc);
349 return_ACPI_STATUS(AE_NO_MEMORY);
353 * Initialize all elements of the package
355 arg = op->common.value.arg;
356 arg = arg->common.next;
357 for (i = 0; arg; i++) {
358 if (arg->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
359 /* Object (package or buffer) is already built */
361 obj_desc->package.elements[i] =
362 ACPI_CAST_PTR(union acpi_operand_object,
365 status = acpi_ds_build_internal_object(walk_state, arg,
370 arg = arg->common.next;
373 obj_desc->package.flags |= AOPOBJ_DATA_VALID;
374 op->common.node = (struct acpi_namespace_node *)obj_desc;
375 return_ACPI_STATUS(status);
378 /*******************************************************************************
380 * FUNCTION: acpi_ds_create_node
382 * PARAMETERS: walk_state - Current walk state
383 * Node - NS Node to be initialized
384 * Op - Parser object to be translated
388 * DESCRIPTION: Create the object to be associated with a namespace node
390 ******************************************************************************/
393 acpi_ds_create_node(struct acpi_walk_state *walk_state,
394 struct acpi_namespace_node *node,
395 union acpi_parse_object *op)
398 union acpi_operand_object *obj_desc;
400 ACPI_FUNCTION_TRACE_PTR("ds_create_node", op);
403 * Because of the execution pass through the non-control-method
404 * parts of the table, we can arrive here twice. Only init
405 * the named object node the first time through
407 if (acpi_ns_get_attached_object(node)) {
408 return_ACPI_STATUS(AE_OK);
411 if (!op->common.value.arg) {
412 /* No arguments, there is nothing to do */
414 return_ACPI_STATUS(AE_OK);
417 /* Build an internal object for the argument(s) */
419 status = acpi_ds_build_internal_object(walk_state, op->common.value.arg,
421 if (ACPI_FAILURE(status)) {
422 return_ACPI_STATUS(status);
425 /* Re-type the object according to its argument */
427 node->type = ACPI_GET_OBJECT_TYPE(obj_desc);
429 /* Attach obj to node */
431 status = acpi_ns_attach_object(node, obj_desc, node->type);
433 /* Remove local reference to the object */
435 acpi_ut_remove_reference(obj_desc);
436 return_ACPI_STATUS(status);
439 #endif /* ACPI_NO_METHOD_EXECUTION */
441 /*******************************************************************************
443 * FUNCTION: acpi_ds_init_object_from_op
445 * PARAMETERS: walk_state - Current walk state
446 * Op - Parser op used to init the internal object
447 * Opcode - AML opcode associated with the object
448 * ret_obj_desc - Namespace object to be initialized
452 * DESCRIPTION: Initialize a namespace object from a parser Op and its
453 * associated arguments. The namespace object is a more compact
454 * representation of the Op and its arguments.
456 ******************************************************************************/
459 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
460 union acpi_parse_object *op,
462 union acpi_operand_object **ret_obj_desc)
464 const struct acpi_opcode_info *op_info;
465 union acpi_operand_object *obj_desc;
466 acpi_status status = AE_OK;
468 ACPI_FUNCTION_TRACE("ds_init_object_from_op");
470 obj_desc = *ret_obj_desc;
471 op_info = acpi_ps_get_opcode_info(opcode);
472 if (op_info->class == AML_CLASS_UNKNOWN) {
475 return_ACPI_STATUS(AE_TYPE);
478 /* Perform per-object initialization */
480 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
481 case ACPI_TYPE_BUFFER:
484 * Defer evaluation of Buffer term_arg operand
486 obj_desc->buffer.node = (struct acpi_namespace_node *)
487 walk_state->operands[0];
488 obj_desc->buffer.aml_start = op->named.data;
489 obj_desc->buffer.aml_length = op->named.length;
492 case ACPI_TYPE_PACKAGE:
495 * Defer evaluation of Package term_arg operand
497 obj_desc->package.node = (struct acpi_namespace_node *)
498 walk_state->operands[0];
499 obj_desc->package.aml_start = op->named.data;
500 obj_desc->package.aml_length = op->named.length;
503 case ACPI_TYPE_INTEGER:
505 switch (op_info->type) {
506 case AML_TYPE_CONSTANT:
508 * Resolve AML Constants here - AND ONLY HERE!
509 * All constants are integers.
510 * We mark the integer with a flag that indicates that it started
511 * life as a constant -- so that stores to constants will perform
512 * as expected (noop). zero_op is used as a placeholder for optional
515 obj_desc->common.flags = AOPOBJ_AML_CONSTANT;
520 obj_desc->integer.value = 0;
525 obj_desc->integer.value = 1;
530 obj_desc->integer.value = ACPI_INTEGER_MAX;
532 /* Truncate value if we are executing from a 32-bit ACPI table */
534 #ifndef ACPI_NO_METHOD_EXECUTION
535 acpi_ex_truncate_for32bit_table(obj_desc);
539 case AML_REVISION_OP:
541 obj_desc->integer.value = ACPI_CA_VERSION;
546 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
547 "Unknown constant opcode %X\n",
549 status = AE_AML_OPERAND_TYPE;
554 case AML_TYPE_LITERAL:
556 obj_desc->integer.value = op->common.value.integer;
557 #ifndef ACPI_NO_METHOD_EXECUTION
558 acpi_ex_truncate_for32bit_table(obj_desc);
563 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
564 "Unknown Integer type %X\n",
566 status = AE_AML_OPERAND_TYPE;
571 case ACPI_TYPE_STRING:
573 obj_desc->string.pointer = op->common.value.string;
574 obj_desc->string.length =
575 (u32) ACPI_STRLEN(op->common.value.string);
578 * The string is contained in the ACPI table, don't ever try
581 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
584 case ACPI_TYPE_METHOD:
587 case ACPI_TYPE_LOCAL_REFERENCE:
589 switch (op_info->type) {
590 case AML_TYPE_LOCAL_VARIABLE:
592 /* Split the opcode into a base opcode + offset */
594 obj_desc->reference.opcode = AML_LOCAL_OP;
595 obj_desc->reference.offset = opcode - AML_LOCAL_OP;
597 #ifndef ACPI_NO_METHOD_EXECUTION
598 status = acpi_ds_method_data_get_node(AML_LOCAL_OP,
609 case AML_TYPE_METHOD_ARGUMENT:
611 /* Split the opcode into a base opcode + offset */
613 obj_desc->reference.opcode = AML_ARG_OP;
614 obj_desc->reference.offset = opcode - AML_ARG_OP;
616 #ifndef ACPI_NO_METHOD_EXECUTION
617 status = acpi_ds_method_data_get_node(AML_ARG_OP,
628 default: /* Other literals, etc.. */
630 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
631 /* Node was saved in Op */
633 obj_desc->reference.node = op->common.node;
636 obj_desc->reference.opcode = opcode;
643 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
644 "Unimplemented data type: %X\n",
645 ACPI_GET_OBJECT_TYPE(obj_desc)));
647 status = AE_AML_OPERAND_TYPE;
651 return_ACPI_STATUS(status);