2 /******************************************************************************
4 * Module Name: exstore - AML Interpreter object store support
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
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>
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 /* Print line header as long as we are not in the middle of an object display */
89 if (!((level
> 0) && index
== 0)) {
90 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "[ACPI Debug] %*s",
94 /* Display index for package output only */
97 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
98 "(%.2u) ", index
- 1));
102 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "[Null Object]\n"));
106 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc
) == ACPI_DESC_TYPE_OPERAND
) {
107 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "%s ",
108 acpi_ut_get_object_type_name
111 if (!acpi_ut_valid_internal_object(source_desc
)) {
112 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
113 "%p, Invalid Internal Object!\n",
117 } else if (ACPI_GET_DESCRIPTOR_TYPE(source_desc
) ==
118 ACPI_DESC_TYPE_NAMED
) {
119 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "%s: %p\n",
120 acpi_ut_get_type_name(((struct
130 /* source_desc is of type ACPI_DESC_TYPE_OPERAND */
132 switch (source_desc
->common
.type
) {
133 case ACPI_TYPE_INTEGER
:
135 /* Output correct integer width */
137 if (acpi_gbl_integer_byte_width
== 4) {
138 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "0x%8.8X\n",
139 (u32
) source_desc
->integer
.
142 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
144 ACPI_FORMAT_UINT64(source_desc
->
150 case ACPI_TYPE_BUFFER
:
152 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "[0x%.2X]\n",
153 (u32
) source_desc
->buffer
.length
));
154 ACPI_DUMP_BUFFER(source_desc
->buffer
.pointer
,
155 (source_desc
->buffer
.length
<
156 256) ? source_desc
->buffer
.length
: 256);
159 case ACPI_TYPE_STRING
:
161 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "[0x%.2X] \"%s\"\n",
162 source_desc
->string
.length
,
163 source_desc
->string
.pointer
));
166 case ACPI_TYPE_PACKAGE
:
168 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
169 "[Contains 0x%.2X Elements]\n",
170 source_desc
->package
.count
));
172 /* Output the entire contents of the package */
174 for (i
= 0; i
< source_desc
->package
.count
; i
++) {
175 acpi_ex_do_debug_object(source_desc
->package
.
176 elements
[i
], level
+ 4, i
+ 1);
180 case ACPI_TYPE_LOCAL_REFERENCE
:
182 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "[%s] ",
183 acpi_ut_get_reference_name(source_desc
)));
185 /* Decode the reference */
187 switch (source_desc
->reference
.class) {
188 case ACPI_REFCLASS_INDEX
:
190 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "0x%X\n",
191 source_desc
->reference
.value
));
194 case ACPI_REFCLASS_TABLE
:
196 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
197 "Table Index 0x%X\n",
198 source_desc
->reference
.value
));
205 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, " "));
207 /* Check for valid node first, then valid object */
209 if (source_desc
->reference
.node
) {
210 if (ACPI_GET_DESCRIPTOR_TYPE
211 (source_desc
->reference
.node
) !=
212 ACPI_DESC_TYPE_NAMED
) {
213 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
214 " %p - Not a valid namespace node\n",
215 source_desc
->reference
.
218 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
,
220 source_desc
->reference
.
222 (source_desc
->reference
.
225 switch ((source_desc
->reference
.node
)->type
) {
227 /* These types have no attached object */
229 case ACPI_TYPE_DEVICE
:
230 acpi_os_printf("Device\n");
233 case ACPI_TYPE_THERMAL
:
234 acpi_os_printf("Thermal Zone\n");
238 acpi_ex_do_debug_object((source_desc
->
245 } else if (source_desc
->reference
.object
) {
246 if (ACPI_GET_DESCRIPTOR_TYPE
247 (source_desc
->reference
.object
) ==
248 ACPI_DESC_TYPE_NAMED
) {
249 acpi_ex_do_debug_object(((struct
250 acpi_namespace_node
*)
251 source_desc
->reference
.
255 acpi_ex_do_debug_object(source_desc
->reference
.
256 object
, level
+ 4, 0);
263 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT
, "%p\n",
268 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC
, "\n"));
272 /*******************************************************************************
274 * FUNCTION: acpi_ex_store
276 * PARAMETERS: *source_desc - Value to be stored
277 * *dest_desc - Where to store it. Must be an NS node
278 * or a union acpi_operand_object of type
280 * walk_state - Current walk state
284 * DESCRIPTION: Store the value described by source_desc into the location
285 * described by dest_desc. Called by various interpreter
286 * functions to store the result of an operation into
287 * the destination operand -- not just simply the actual "Store"
290 ******************************************************************************/
293 acpi_ex_store(union acpi_operand_object
*source_desc
,
294 union acpi_operand_object
*dest_desc
,
295 struct acpi_walk_state
*walk_state
)
297 acpi_status status
= AE_OK
;
298 union acpi_operand_object
*ref_desc
= dest_desc
;
300 ACPI_FUNCTION_TRACE_PTR(ex_store
, dest_desc
);
302 /* Validate parameters */
304 if (!source_desc
|| !dest_desc
) {
305 ACPI_ERROR((AE_INFO
, "Null parameter"));
306 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
309 /* dest_desc can be either a namespace node or an ACPI object */
311 if (ACPI_GET_DESCRIPTOR_TYPE(dest_desc
) == ACPI_DESC_TYPE_NAMED
) {
313 * Dest is a namespace node,
314 * Storing an object into a Named node.
316 status
= acpi_ex_store_object_to_node(source_desc
,
318 acpi_namespace_node
*)
319 dest_desc
, walk_state
,
320 ACPI_IMPLICIT_CONVERSION
);
322 return_ACPI_STATUS(status
);
325 /* Destination object must be a Reference or a Constant object */
327 switch (dest_desc
->common
.type
) {
328 case ACPI_TYPE_LOCAL_REFERENCE
:
331 case ACPI_TYPE_INTEGER
:
333 /* Allow stores to Constants -- a Noop as per ACPI spec */
335 if (dest_desc
->common
.flags
& AOPOBJ_AML_CONSTANT
) {
336 return_ACPI_STATUS(AE_OK
);
339 /*lint -fallthrough */
343 /* Destination is not a Reference object */
346 "Target is not a Reference or Constant object - %s [%p]",
347 acpi_ut_get_object_type_name(dest_desc
),
350 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
354 * Examine the Reference class. These cases are handled:
356 * 1) Store to Name (Change the object associated with a name)
357 * 2) Store to an indexed area of a Buffer or Package
358 * 3) Store to a Method Local or Arg
359 * 4) Store to the debug object
361 switch (ref_desc
->reference
.class) {
362 case ACPI_REFCLASS_REFOF
:
364 /* Storing an object into a Name "container" */
366 status
= acpi_ex_store_object_to_node(source_desc
,
369 ACPI_IMPLICIT_CONVERSION
);
372 case ACPI_REFCLASS_INDEX
:
374 /* Storing to an Index (pointer into a packager or buffer) */
377 acpi_ex_store_object_to_index(source_desc
, ref_desc
,
381 case ACPI_REFCLASS_LOCAL
:
382 case ACPI_REFCLASS_ARG
:
384 /* Store to a method local/arg */
387 acpi_ds_store_object_to_local(ref_desc
->reference
.class,
388 ref_desc
->reference
.value
,
389 source_desc
, walk_state
);
392 case ACPI_REFCLASS_DEBUG
:
395 * Storing to the Debug object causes the value stored to be
396 * displayed and otherwise has no effect -- see ACPI Specification
398 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
399 "**** Write to Debug Object: Object %p %s ****:\n\n",
401 acpi_ut_get_object_type_name(source_desc
)));
403 acpi_ex_do_debug_object(source_desc
, 0, 0);
408 ACPI_ERROR((AE_INFO
, "Unknown Reference Class %2.2X",
409 ref_desc
->reference
.class));
410 ACPI_DUMP_ENTRY(ref_desc
, ACPI_LV_INFO
);
412 status
= AE_AML_INTERNAL
;
416 return_ACPI_STATUS(status
);
419 /*******************************************************************************
421 * FUNCTION: acpi_ex_store_object_to_index
423 * PARAMETERS: *source_desc - Value to be stored
424 * *dest_desc - Named object to receive the value
425 * walk_state - Current walk state
429 * DESCRIPTION: Store the object to indexed Buffer or Package element
431 ******************************************************************************/
434 acpi_ex_store_object_to_index(union acpi_operand_object
*source_desc
,
435 union acpi_operand_object
*index_desc
,
436 struct acpi_walk_state
*walk_state
)
438 acpi_status status
= AE_OK
;
439 union acpi_operand_object
*obj_desc
;
440 union acpi_operand_object
*new_desc
;
444 ACPI_FUNCTION_TRACE(ex_store_object_to_index
);
447 * Destination must be a reference pointer, and
448 * must point to either a buffer or a package
450 switch (index_desc
->reference
.target_type
) {
451 case ACPI_TYPE_PACKAGE
:
453 * Storing to a package element. Copy the object and replace
454 * any existing object with the new object. No implicit
455 * conversion is performed.
457 * The object at *(index_desc->Reference.Where) is the
458 * element within the package that is to be modified.
459 * The parent package object is at index_desc->Reference.Object
461 obj_desc
= *(index_desc
->reference
.where
);
463 if (source_desc
->common
.type
== ACPI_TYPE_LOCAL_REFERENCE
&&
464 source_desc
->reference
.class == ACPI_REFCLASS_TABLE
) {
466 /* This is a DDBHandle, just add a reference to it */
468 acpi_ut_add_reference(source_desc
);
469 new_desc
= source_desc
;
471 /* Normal object, copy it */
474 acpi_ut_copy_iobject_to_iobject(source_desc
,
477 if (ACPI_FAILURE(status
)) {
478 return_ACPI_STATUS(status
);
484 /* Decrement reference count by the ref count of the parent package */
486 for (i
= 0; i
< ((union acpi_operand_object
*)
487 index_desc
->reference
.object
)->common
.
488 reference_count
; i
++) {
489 acpi_ut_remove_reference(obj_desc
);
493 *(index_desc
->reference
.where
) = new_desc
;
495 /* Increment ref count by the ref count of the parent package-1 */
497 for (i
= 1; i
< ((union acpi_operand_object
*)
498 index_desc
->reference
.object
)->common
.
499 reference_count
; i
++) {
500 acpi_ut_add_reference(new_desc
);
505 case ACPI_TYPE_BUFFER_FIELD
:
508 * Store into a Buffer or String (not actually a real buffer_field)
509 * at a location defined by an Index.
511 * The first 8-bit element of the source object is written to the
512 * 8-bit Buffer location defined by the Index destination object,
513 * according to the ACPI 2.0 specification.
517 * Make sure the target is a Buffer or String. An error should
518 * not happen here, since the reference_object was constructed
519 * by the INDEX_OP code.
521 obj_desc
= index_desc
->reference
.object
;
522 if ((obj_desc
->common
.type
!= ACPI_TYPE_BUFFER
) &&
523 (obj_desc
->common
.type
!= ACPI_TYPE_STRING
)) {
524 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
528 * The assignment of the individual elements will be slightly
529 * different for each source type.
531 switch (source_desc
->common
.type
) {
532 case ACPI_TYPE_INTEGER
:
534 /* Use the least-significant byte of the integer */
536 value
= (u8
) (source_desc
->integer
.value
);
539 case ACPI_TYPE_BUFFER
:
540 case ACPI_TYPE_STRING
:
542 /* Note: Takes advantage of common string/buffer fields */
544 value
= source_desc
->buffer
.pointer
[0];
549 /* All other types are invalid */
552 "Source must be Integer/Buffer/String type, not %s",
553 acpi_ut_get_object_type_name(source_desc
)));
554 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
557 /* Store the source value into the target buffer byte */
559 obj_desc
->buffer
.pointer
[index_desc
->reference
.value
] = value
;
563 ACPI_ERROR((AE_INFO
, "Target is not a Package or BufferField"));
564 status
= AE_AML_OPERAND_TYPE
;
568 return_ACPI_STATUS(status
);
571 /*******************************************************************************
573 * FUNCTION: acpi_ex_store_object_to_node
575 * PARAMETERS: source_desc - Value to be stored
576 * Node - Named object to receive the value
577 * walk_state - Current walk state
578 * implicit_conversion - Perform implicit conversion (yes/no)
582 * DESCRIPTION: Store the object to the named object.
584 * The Assignment of an object to a named object is handled here
585 * The value passed in will replace the current value (if any)
586 * with the input value.
588 * When storing into an object the data is converted to the
589 * target object type then stored in the object. This means
590 * that the target object type (for an initialized target) will
591 * not be changed by a store operation.
593 * Assumes parameters are already validated.
595 ******************************************************************************/
598 acpi_ex_store_object_to_node(union acpi_operand_object
*source_desc
,
599 struct acpi_namespace_node
*node
,
600 struct acpi_walk_state
*walk_state
,
601 u8 implicit_conversion
)
603 acpi_status status
= AE_OK
;
604 union acpi_operand_object
*target_desc
;
605 union acpi_operand_object
*new_desc
;
606 acpi_object_type target_type
;
608 ACPI_FUNCTION_TRACE_PTR(ex_store_object_to_node
, source_desc
);
610 /* Get current type of the node, and object attached to Node */
612 target_type
= acpi_ns_get_type(node
);
613 target_desc
= acpi_ns_get_attached_object(node
);
615 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Storing %p(%s) into node %p(%s)\n",
617 acpi_ut_get_object_type_name(source_desc
), node
,
618 acpi_ut_get_type_name(target_type
)));
621 * Resolve the source object to an actual value
622 * (If it is a reference object)
624 status
= acpi_ex_resolve_object(&source_desc
, target_type
, walk_state
);
625 if (ACPI_FAILURE(status
)) {
626 return_ACPI_STATUS(status
);
629 /* If no implicit conversion, drop into the default case below */
631 if ((!implicit_conversion
) ||
632 ((walk_state
->opcode
== AML_COPY_OP
) &&
633 (target_type
!= ACPI_TYPE_LOCAL_REGION_FIELD
) &&
634 (target_type
!= ACPI_TYPE_LOCAL_BANK_FIELD
) &&
635 (target_type
!= ACPI_TYPE_LOCAL_INDEX_FIELD
))) {
637 * Force execution of default (no implicit conversion). Note:
638 * copy_object does not perform an implicit conversion, as per the ACPI
639 * spec -- except in case of region/bank/index fields -- because these
640 * objects must retain their original type permanently.
642 target_type
= ACPI_TYPE_ANY
;
645 /* Do the actual store operation */
647 switch (target_type
) {
648 case ACPI_TYPE_BUFFER_FIELD
:
649 case ACPI_TYPE_LOCAL_REGION_FIELD
:
650 case ACPI_TYPE_LOCAL_BANK_FIELD
:
651 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
653 /* For fields, copy the source data to the target field. */
655 status
= acpi_ex_write_data_to_field(source_desc
, target_desc
,
656 &walk_state
->result_obj
);
659 case ACPI_TYPE_INTEGER
:
660 case ACPI_TYPE_STRING
:
661 case ACPI_TYPE_BUFFER
:
664 * These target types are all of type Integer/String/Buffer, and
665 * therefore support implicit conversion before the store.
667 * Copy and/or convert the source object to a new target object
670 acpi_ex_store_object_to_object(source_desc
, target_desc
,
671 &new_desc
, walk_state
);
672 if (ACPI_FAILURE(status
)) {
673 return_ACPI_STATUS(status
);
676 if (new_desc
!= target_desc
) {
678 * Store the new new_desc as the new value of the Name, and set
679 * the Name's type to that of the value being stored in it.
680 * source_desc reference count is incremented by attach_object.
682 * Note: This may change the type of the node if an explicit store
683 * has been performed such that the node/object type has been
687 acpi_ns_attach_object(node
, new_desc
,
688 new_desc
->common
.type
);
690 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
691 "Store %s into %s via Convert/Attach\n",
692 acpi_ut_get_object_type_name
694 acpi_ut_get_object_type_name
701 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
702 "Storing %s (%p) directly into node (%p) with no implicit conversion\n",
703 acpi_ut_get_object_type_name(source_desc
),
706 /* No conversions for all other types. Just attach the source object */
708 status
= acpi_ns_attach_object(node
, source_desc
,
709 source_desc
->common
.type
);
713 return_ACPI_STATUS(status
);