1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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_REPORT_ERROR(("Expecting bytelist, got AML opcode %X in op %p\n", byte_list->common.aml_opcode, byte_list));
219 acpi_ut_remove_reference(obj_desc);
223 byte_list_length = (u32) byte_list->common.value.integer;
227 * The buffer length (number of bytes) will be the larger of:
228 * 1) The specified buffer length and
229 * 2) The length of the initializer byte list
231 obj_desc->buffer.length = buffer_length;
232 if (byte_list_length > buffer_length) {
233 obj_desc->buffer.length = byte_list_length;
236 /* Allocate the buffer */
238 if (obj_desc->buffer.length == 0) {
239 obj_desc->buffer.pointer = NULL;
240 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
241 "Buffer defined with zero length in AML, creating\n"));
243 obj_desc->buffer.pointer =
244 ACPI_MEM_CALLOCATE(obj_desc->buffer.length);
245 if (!obj_desc->buffer.pointer) {
246 acpi_ut_delete_object_desc(obj_desc);
247 return_ACPI_STATUS(AE_NO_MEMORY);
250 /* Initialize buffer from the byte_list (if present) */
253 ACPI_MEMCPY(obj_desc->buffer.pointer,
254 byte_list->named.data, byte_list_length);
258 obj_desc->buffer.flags |= AOPOBJ_DATA_VALID;
259 op->common.node = (struct acpi_namespace_node *)obj_desc;
260 return_ACPI_STATUS(AE_OK);
263 /*******************************************************************************
265 * FUNCTION: acpi_ds_build_internal_package_obj
267 * PARAMETERS: walk_state - Current walk state
268 * Op - Parser object to be translated
269 * package_length - Number of elements in the package
270 * obj_desc_ptr - Where the ACPI internal object is returned
274 * DESCRIPTION: Translate a parser Op package object to the equivalent
277 ******************************************************************************/
280 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
281 union acpi_parse_object *op,
283 union acpi_operand_object **obj_desc_ptr)
285 union acpi_parse_object *arg;
286 union acpi_parse_object *parent;
287 union acpi_operand_object *obj_desc = NULL;
288 u32 package_list_length;
289 acpi_status status = AE_OK;
292 ACPI_FUNCTION_TRACE("ds_build_internal_package_obj");
294 /* Find the parent of a possibly nested package */
296 parent = op->common.parent;
297 while ((parent->common.aml_opcode == AML_PACKAGE_OP) ||
298 (parent->common.aml_opcode == AML_VAR_PACKAGE_OP)) {
299 parent = parent->common.parent;
303 * If we are evaluating a Named package object "Name (xxxx, Package)",
304 * the package object already exists, otherwise it must be created.
306 obj_desc = *obj_desc_ptr;
308 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
309 *obj_desc_ptr = obj_desc;
311 return_ACPI_STATUS(AE_NO_MEMORY);
314 obj_desc->package.node = parent->common.node;
317 obj_desc->package.count = package_length;
319 /* Count the number of items in the package list */
321 arg = op->common.value.arg;
322 arg = arg->common.next;
323 for (package_list_length = 0; arg; package_list_length++) {
324 arg = arg->common.next;
328 * The package length (number of elements) will be the greater
329 * of the specified length and the length of the initializer list
331 if (package_list_length > package_length) {
332 obj_desc->package.count = package_list_length;
336 * Allocate the pointer array (array of pointers to the
337 * individual objects). Add an extra pointer slot so
338 * that the list is always null terminated.
340 obj_desc->package.elements = ACPI_MEM_CALLOCATE(((acpi_size) obj_desc->
342 1) * sizeof(void *));
344 if (!obj_desc->package.elements) {
345 acpi_ut_delete_object_desc(obj_desc);
346 return_ACPI_STATUS(AE_NO_MEMORY);
350 * Initialize all elements of the package
352 arg = op->common.value.arg;
353 arg = arg->common.next;
354 for (i = 0; arg; i++) {
355 if (arg->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
356 /* Object (package or buffer) is already built */
358 obj_desc->package.elements[i] =
359 ACPI_CAST_PTR(union acpi_operand_object,
362 status = acpi_ds_build_internal_object(walk_state, arg,
367 arg = arg->common.next;
370 obj_desc->package.flags |= AOPOBJ_DATA_VALID;
371 op->common.node = (struct acpi_namespace_node *)obj_desc;
372 return_ACPI_STATUS(status);
375 /*******************************************************************************
377 * FUNCTION: acpi_ds_create_node
379 * PARAMETERS: walk_state - Current walk state
380 * Node - NS Node to be initialized
381 * Op - Parser object to be translated
385 * DESCRIPTION: Create the object to be associated with a namespace node
387 ******************************************************************************/
390 acpi_ds_create_node(struct acpi_walk_state *walk_state,
391 struct acpi_namespace_node *node,
392 union acpi_parse_object *op)
395 union acpi_operand_object *obj_desc;
397 ACPI_FUNCTION_TRACE_PTR("ds_create_node", op);
400 * Because of the execution pass through the non-control-method
401 * parts of the table, we can arrive here twice. Only init
402 * the named object node the first time through
404 if (acpi_ns_get_attached_object(node)) {
405 return_ACPI_STATUS(AE_OK);
408 if (!op->common.value.arg) {
409 /* No arguments, there is nothing to do */
411 return_ACPI_STATUS(AE_OK);
414 /* Build an internal object for the argument(s) */
416 status = acpi_ds_build_internal_object(walk_state, op->common.value.arg,
418 if (ACPI_FAILURE(status)) {
419 return_ACPI_STATUS(status);
422 /* Re-type the object according to its argument */
424 node->type = ACPI_GET_OBJECT_TYPE(obj_desc);
426 /* Attach obj to node */
428 status = acpi_ns_attach_object(node, obj_desc, node->type);
430 /* Remove local reference to the object */
432 acpi_ut_remove_reference(obj_desc);
433 return_ACPI_STATUS(status);
436 #endif /* ACPI_NO_METHOD_EXECUTION */
438 /*******************************************************************************
440 * FUNCTION: acpi_ds_init_object_from_op
442 * PARAMETERS: walk_state - Current walk state
443 * Op - Parser op used to init the internal object
444 * Opcode - AML opcode associated with the object
445 * ret_obj_desc - Namespace object to be initialized
449 * DESCRIPTION: Initialize a namespace object from a parser Op and its
450 * associated arguments. The namespace object is a more compact
451 * representation of the Op and its arguments.
453 ******************************************************************************/
456 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
457 union acpi_parse_object *op,
459 union acpi_operand_object **ret_obj_desc)
461 const struct acpi_opcode_info *op_info;
462 union acpi_operand_object *obj_desc;
463 acpi_status status = AE_OK;
465 ACPI_FUNCTION_TRACE("ds_init_object_from_op");
467 obj_desc = *ret_obj_desc;
468 op_info = acpi_ps_get_opcode_info(opcode);
469 if (op_info->class == AML_CLASS_UNKNOWN) {
472 return_ACPI_STATUS(AE_TYPE);
475 /* Perform per-object initialization */
477 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
478 case ACPI_TYPE_BUFFER:
481 * Defer evaluation of Buffer term_arg operand
483 obj_desc->buffer.node = (struct acpi_namespace_node *)
484 walk_state->operands[0];
485 obj_desc->buffer.aml_start = op->named.data;
486 obj_desc->buffer.aml_length = op->named.length;
489 case ACPI_TYPE_PACKAGE:
492 * Defer evaluation of Package term_arg operand
494 obj_desc->package.node = (struct acpi_namespace_node *)
495 walk_state->operands[0];
496 obj_desc->package.aml_start = op->named.data;
497 obj_desc->package.aml_length = op->named.length;
500 case ACPI_TYPE_INTEGER:
502 switch (op_info->type) {
503 case AML_TYPE_CONSTANT:
505 * Resolve AML Constants here - AND ONLY HERE!
506 * All constants are integers.
507 * We mark the integer with a flag that indicates that it started
508 * life as a constant -- so that stores to constants will perform
509 * as expected (noop). zero_op is used as a placeholder for optional
512 obj_desc->common.flags = AOPOBJ_AML_CONSTANT;
517 obj_desc->integer.value = 0;
522 obj_desc->integer.value = 1;
527 obj_desc->integer.value = ACPI_INTEGER_MAX;
529 /* Truncate value if we are executing from a 32-bit ACPI table */
531 #ifndef ACPI_NO_METHOD_EXECUTION
532 acpi_ex_truncate_for32bit_table(obj_desc);
536 case AML_REVISION_OP:
538 obj_desc->integer.value = ACPI_CA_VERSION;
543 ACPI_REPORT_ERROR(("Unknown constant opcode %X\n", opcode));
544 status = AE_AML_OPERAND_TYPE;
549 case AML_TYPE_LITERAL:
551 obj_desc->integer.value = op->common.value.integer;
552 #ifndef ACPI_NO_METHOD_EXECUTION
553 acpi_ex_truncate_for32bit_table(obj_desc);
558 ACPI_REPORT_ERROR(("Unknown Integer type %X\n",
560 status = AE_AML_OPERAND_TYPE;
565 case ACPI_TYPE_STRING:
567 obj_desc->string.pointer = op->common.value.string;
568 obj_desc->string.length =
569 (u32) ACPI_STRLEN(op->common.value.string);
572 * The string is contained in the ACPI table, don't ever try
575 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
578 case ACPI_TYPE_METHOD:
581 case ACPI_TYPE_LOCAL_REFERENCE:
583 switch (op_info->type) {
584 case AML_TYPE_LOCAL_VARIABLE:
586 /* Split the opcode into a base opcode + offset */
588 obj_desc->reference.opcode = AML_LOCAL_OP;
589 obj_desc->reference.offset = opcode - AML_LOCAL_OP;
591 #ifndef ACPI_NO_METHOD_EXECUTION
592 status = acpi_ds_method_data_get_node(AML_LOCAL_OP,
603 case AML_TYPE_METHOD_ARGUMENT:
605 /* Split the opcode into a base opcode + offset */
607 obj_desc->reference.opcode = AML_ARG_OP;
608 obj_desc->reference.offset = opcode - AML_ARG_OP;
610 #ifndef ACPI_NO_METHOD_EXECUTION
611 status = acpi_ds_method_data_get_node(AML_ARG_OP,
622 default: /* Other literals, etc.. */
624 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
625 /* Node was saved in Op */
627 obj_desc->reference.node = op->common.node;
630 obj_desc->reference.opcode = opcode;
637 ACPI_REPORT_ERROR(("Unimplemented data type: %X\n",
638 ACPI_GET_OBJECT_TYPE(obj_desc)));
640 status = AE_AML_OPERAND_TYPE;
644 return_ACPI_STATUS(status);