2 /******************************************************************************
4 * Module Name: exstore - AML Interpreter object store support
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/acdispat.h>
47 #include <acpi/acinterp.h>
48 #include <acpi/amlcode.h>
49 #include <acpi/acnamesp.h>
50 #include <acpi/acparser.h>
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME("exstore")
55 /* Local prototypes */
57 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
58 u32 level, u32 index);
61 acpi_ex_store_object_to_index(union acpi_operand_object *val_desc,
62 union acpi_operand_object *dest_desc,
63 struct acpi_walk_state *walk_state);
65 /*******************************************************************************
67 * FUNCTION: acpi_ex_do_debug_object
69 * PARAMETERS: source_desc - Value to be stored
70 * Level - Indentation level (used for packages)
71 * Index - Current package element, zero if not pkg
75 * DESCRIPTION: Handles stores to the Debug Object.
77 ******************************************************************************/
80 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
85 ACPI_FUNCTION_TRACE_PTR("ex_do_debug_object", source_desc);
87 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[ACPI Debug] %*s",
90 /* Display index for package output only */
93 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
94 "(%.2u) ", index - 1));
98 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "<Null Object>\n"));
102 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_OPERAND) {
103 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%s: ",
104 acpi_ut_get_object_type_name
107 if (!acpi_ut_valid_internal_object(source_desc)) {
108 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
109 "%p, Invalid Internal Object!\n",
113 } else if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) ==
114 ACPI_DESC_TYPE_NAMED) {
115 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%s: %p\n",
116 acpi_ut_get_type_name(((struct
126 switch (ACPI_GET_OBJECT_TYPE(source_desc)) {
127 case ACPI_TYPE_INTEGER:
129 /* Output correct integer width */
131 if (acpi_gbl_integer_byte_width == 4) {
132 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "0x%8.8X\n",
133 (u32) source_desc->integer.
136 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
138 ACPI_FORMAT_UINT64(source_desc->
144 case ACPI_TYPE_BUFFER:
146 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[0x%.2X]\n",
147 (u32) source_desc->buffer.length));
148 ACPI_DUMP_BUFFER(source_desc->buffer.pointer,
149 (source_desc->buffer.length <
150 32) ? source_desc->buffer.length : 32);
153 case ACPI_TYPE_STRING:
155 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[0x%.2X] \"%s\"\n",
156 source_desc->string.length,
157 source_desc->string.pointer));
160 case ACPI_TYPE_PACKAGE:
162 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
163 "[0x%.2X Elements]\n",
164 source_desc->package.count));
166 /* Output the entire contents of the package */
168 for (i = 0; i < source_desc->package.count; i++) {
169 acpi_ex_do_debug_object(source_desc->package.
170 elements[i], level + 4, i + 1);
174 case ACPI_TYPE_LOCAL_REFERENCE:
176 if (source_desc->reference.opcode == AML_INDEX_OP) {
177 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
179 acpi_ps_get_opcode_name
180 (source_desc->reference.opcode),
181 source_desc->reference.offset));
183 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[%s]\n",
184 acpi_ps_get_opcode_name
185 (source_desc->reference.opcode)));
188 if (source_desc->reference.object) {
189 if (ACPI_GET_DESCRIPTOR_TYPE
190 (source_desc->reference.object) ==
191 ACPI_DESC_TYPE_NAMED) {
192 acpi_ex_do_debug_object(((struct
193 acpi_namespace_node *)
194 source_desc->reference.
198 acpi_ex_do_debug_object(source_desc->reference.
199 object, level + 4, 0);
201 } else if (source_desc->reference.node) {
202 acpi_ex_do_debug_object((source_desc->reference.node)->
203 object, level + 4, 0);
209 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%p %s\n",
211 acpi_ut_get_object_type_name
216 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "\n"));
220 /*******************************************************************************
222 * FUNCTION: acpi_ex_store
224 * PARAMETERS: *source_desc - Value to be stored
225 * *dest_desc - Where to store it. Must be an NS node
226 * or an union acpi_operand_object of type
228 * walk_state - Current walk state
232 * DESCRIPTION: Store the value described by source_desc into the location
233 * described by dest_desc. Called by various interpreter
234 * functions to store the result of an operation into
235 * the destination operand -- not just simply the actual "Store"
238 ******************************************************************************/
241 acpi_ex_store(union acpi_operand_object *source_desc,
242 union acpi_operand_object *dest_desc,
243 struct acpi_walk_state *walk_state)
245 acpi_status status = AE_OK;
246 union acpi_operand_object *ref_desc = dest_desc;
248 ACPI_FUNCTION_TRACE_PTR("ex_store", dest_desc);
250 /* Validate parameters */
252 if (!source_desc || !dest_desc) {
253 ACPI_REPORT_ERROR(("Null parameter\n"));
254 return_ACPI_STATUS(AE_AML_NO_OPERAND);
257 /* dest_desc can be either a namespace node or an ACPI object */
259 if (ACPI_GET_DESCRIPTOR_TYPE(dest_desc) == ACPI_DESC_TYPE_NAMED) {
261 * Dest is a namespace node,
262 * Storing an object into a Named node.
264 status = acpi_ex_store_object_to_node(source_desc,
266 acpi_namespace_node *)
267 dest_desc, walk_state,
268 ACPI_IMPLICIT_CONVERSION);
270 return_ACPI_STATUS(status);
273 /* Destination object must be a Reference or a Constant object */
275 switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
276 case ACPI_TYPE_LOCAL_REFERENCE:
279 case ACPI_TYPE_INTEGER:
281 /* Allow stores to Constants -- a Noop as per ACPI spec */
283 if (dest_desc->common.flags & AOPOBJ_AML_CONSTANT) {
284 return_ACPI_STATUS(AE_OK);
287 /*lint -fallthrough */
291 /* Destination is not a Reference object */
293 ACPI_REPORT_ERROR(("Target is not a Reference or Constant object - %s [%p]\n", acpi_ut_get_object_type_name(dest_desc), dest_desc));
295 ACPI_DUMP_STACK_ENTRY(source_desc);
296 ACPI_DUMP_STACK_ENTRY(dest_desc);
297 ACPI_DUMP_OPERANDS(&dest_desc, ACPI_IMODE_EXECUTE, "ex_store",
299 "Target is not a Reference or Constant object");
301 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
305 * Examine the Reference opcode. These cases are handled:
307 * 1) Store to Name (Change the object associated with a name)
308 * 2) Store to an indexed area of a Buffer or Package
309 * 3) Store to a Method Local or Arg
310 * 4) Store to the debug object
312 switch (ref_desc->reference.opcode) {
316 /* Storing an object into a Name "container" */
318 status = acpi_ex_store_object_to_node(source_desc,
321 ACPI_IMPLICIT_CONVERSION);
326 /* Storing to an Index (pointer into a packager or buffer) */
329 acpi_ex_store_object_to_index(source_desc, ref_desc,
336 /* Store to a method local/arg */
339 acpi_ds_store_object_to_local(ref_desc->reference.opcode,
340 ref_desc->reference.offset,
341 source_desc, walk_state);
347 * Storing to the Debug object causes the value stored to be
348 * displayed and otherwise has no effect -- see ACPI Specification
350 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
351 "**** Write to Debug Object: Object %p %s ****:\n\n",
353 acpi_ut_get_object_type_name(source_desc)));
355 acpi_ex_do_debug_object(source_desc, 0, 0);
360 ACPI_REPORT_ERROR(("Unknown Reference opcode %X\n",
361 ref_desc->reference.opcode));
362 ACPI_DUMP_ENTRY(ref_desc, ACPI_LV_ERROR);
364 status = AE_AML_INTERNAL;
368 return_ACPI_STATUS(status);
371 /*******************************************************************************
373 * FUNCTION: acpi_ex_store_object_to_index
375 * PARAMETERS: *source_desc - Value to be stored
376 * *dest_desc - Named object to receive the value
377 * walk_state - Current walk state
381 * DESCRIPTION: Store the object to indexed Buffer or Package element
383 ******************************************************************************/
386 acpi_ex_store_object_to_index(union acpi_operand_object *source_desc,
387 union acpi_operand_object *index_desc,
388 struct acpi_walk_state *walk_state)
390 acpi_status status = AE_OK;
391 union acpi_operand_object *obj_desc;
392 union acpi_operand_object *new_desc;
396 ACPI_FUNCTION_TRACE("ex_store_object_to_index");
399 * Destination must be a reference pointer, and
400 * must point to either a buffer or a package
402 switch (index_desc->reference.target_type) {
403 case ACPI_TYPE_PACKAGE:
405 * Storing to a package element. Copy the object and replace
406 * any existing object with the new object. No implicit
407 * conversion is performed.
409 * The object at *(index_desc->Reference.Where) is the
410 * element within the package that is to be modified.
411 * The parent package object is at index_desc->Reference.Object
413 obj_desc = *(index_desc->reference.where);
416 acpi_ut_copy_iobject_to_iobject(source_desc, &new_desc,
418 if (ACPI_FAILURE(status)) {
419 return_ACPI_STATUS(status);
423 /* Decrement reference count by the ref count of the parent package */
425 for (i = 0; i < ((union acpi_operand_object *)
426 index_desc->reference.object)->common.
427 reference_count; i++) {
428 acpi_ut_remove_reference(obj_desc);
432 *(index_desc->reference.where) = new_desc;
434 /* Increment ref count by the ref count of the parent package-1 */
436 for (i = 1; i < ((union acpi_operand_object *)
437 index_desc->reference.object)->common.
438 reference_count; i++) {
439 acpi_ut_add_reference(new_desc);
444 case ACPI_TYPE_BUFFER_FIELD:
447 * Store into a Buffer or String (not actually a real buffer_field)
448 * at a location defined by an Index.
450 * The first 8-bit element of the source object is written to the
451 * 8-bit Buffer location defined by the Index destination object,
452 * according to the ACPI 2.0 specification.
456 * Make sure the target is a Buffer or String. An error should
457 * not happen here, since the reference_object was constructed
458 * by the INDEX_OP code.
460 obj_desc = index_desc->reference.object;
461 if ((ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_BUFFER) &&
462 (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_STRING)) {
463 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
467 * The assignment of the individual elements will be slightly
468 * different for each source type.
470 switch (ACPI_GET_OBJECT_TYPE(source_desc)) {
471 case ACPI_TYPE_INTEGER:
473 /* Use the least-significant byte of the integer */
475 value = (u8) (source_desc->integer.value);
478 case ACPI_TYPE_BUFFER:
479 case ACPI_TYPE_STRING:
481 /* Note: Takes advantage of common string/buffer fields */
483 value = source_desc->buffer.pointer[0];
488 /* All other types are invalid */
490 ACPI_REPORT_ERROR(("Source must be Integer/Buffer/String type, not %s\n", acpi_ut_get_object_type_name(source_desc)));
491 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
494 /* Store the source value into the target buffer byte */
496 obj_desc->buffer.pointer[index_desc->reference.offset] = value;
500 ACPI_REPORT_ERROR(("Target is not a Package or buffer_field\n"));
501 status = AE_AML_OPERAND_TYPE;
505 return_ACPI_STATUS(status);
508 /*******************************************************************************
510 * FUNCTION: acpi_ex_store_object_to_node
512 * PARAMETERS: source_desc - Value to be stored
513 * Node - Named object to receive the value
514 * walk_state - Current walk state
515 * implicit_conversion - Perform implicit conversion (yes/no)
519 * DESCRIPTION: Store the object to the named object.
521 * The Assignment of an object to a named object is handled here
522 * The value passed in will replace the current value (if any)
523 * with the input value.
525 * When storing into an object the data is converted to the
526 * target object type then stored in the object. This means
527 * that the target object type (for an initialized target) will
528 * not be changed by a store operation.
530 * Assumes parameters are already validated.
532 ******************************************************************************/
535 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
536 struct acpi_namespace_node *node,
537 struct acpi_walk_state *walk_state,
538 u8 implicit_conversion)
540 acpi_status status = AE_OK;
541 union acpi_operand_object *target_desc;
542 union acpi_operand_object *new_desc;
543 acpi_object_type target_type;
545 ACPI_FUNCTION_TRACE_PTR("ex_store_object_to_node", source_desc);
547 /* Get current type of the node, and object attached to Node */
549 target_type = acpi_ns_get_type(node);
550 target_desc = acpi_ns_get_attached_object(node);
552 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Storing %p(%s) into node %p(%s)\n",
554 acpi_ut_get_object_type_name(source_desc), node,
555 acpi_ut_get_type_name(target_type)));
558 * Resolve the source object to an actual value
559 * (If it is a reference object)
561 status = acpi_ex_resolve_object(&source_desc, target_type, walk_state);
562 if (ACPI_FAILURE(status)) {
563 return_ACPI_STATUS(status);
566 /* If no implicit conversion, drop into the default case below */
568 if ((!implicit_conversion) || (walk_state->opcode == AML_COPY_OP)) {
569 /* Force execution of default (no implicit conversion) */
571 target_type = ACPI_TYPE_ANY;
574 /* Do the actual store operation */
576 switch (target_type) {
577 case ACPI_TYPE_BUFFER_FIELD:
578 case ACPI_TYPE_LOCAL_REGION_FIELD:
579 case ACPI_TYPE_LOCAL_BANK_FIELD:
580 case ACPI_TYPE_LOCAL_INDEX_FIELD:
582 /* For fields, copy the source data to the target field. */
584 status = acpi_ex_write_data_to_field(source_desc, target_desc,
585 &walk_state->result_obj);
588 case ACPI_TYPE_INTEGER:
589 case ACPI_TYPE_STRING:
590 case ACPI_TYPE_BUFFER:
593 * These target types are all of type Integer/String/Buffer, and
594 * therefore support implicit conversion before the store.
596 * Copy and/or convert the source object to a new target object
599 acpi_ex_store_object_to_object(source_desc, target_desc,
600 &new_desc, walk_state);
601 if (ACPI_FAILURE(status)) {
602 return_ACPI_STATUS(status);
605 if (new_desc != target_desc) {
607 * Store the new new_desc as the new value of the Name, and set
608 * the Name's type to that of the value being stored in it.
609 * source_desc reference count is incremented by attach_object.
611 * Note: This may change the type of the node if an explicit store
612 * has been performed such that the node/object type has been
616 acpi_ns_attach_object(node, new_desc,
617 new_desc->common.type);
619 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
620 "Store %s into %s via Convert/Attach\n",
621 acpi_ut_get_object_type_name
623 acpi_ut_get_object_type_name
630 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
631 "Storing %s (%p) directly into node (%p) with no implicit conversion\n",
632 acpi_ut_get_object_type_name(source_desc),
635 /* No conversions for all other types. Just attach the source object */
637 status = acpi_ns_attach_object(node, source_desc,
643 return_ACPI_STATUS(status);