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_ERROR((AE_INFO
, "Null parameter"));
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 */
294 "Target is not a Reference or Constant object - %s [%p]",
295 acpi_ut_get_object_type_name(dest_desc
),
298 ACPI_DUMP_STACK_ENTRY(source_desc
);
299 ACPI_DUMP_STACK_ENTRY(dest_desc
);
300 ACPI_DUMP_OPERANDS(&dest_desc
, ACPI_IMODE_EXECUTE
, "ExStore",
302 "Target is not a Reference or Constant object");
304 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
308 * Examine the Reference opcode. These cases are handled:
310 * 1) Store to Name (Change the object associated with a name)
311 * 2) Store to an indexed area of a Buffer or Package
312 * 3) Store to a Method Local or Arg
313 * 4) Store to the debug object
315 switch (ref_desc
->reference
.opcode
) {
319 /* Storing an object into a Name "container" */
321 status
= acpi_ex_store_object_to_node(source_desc
,
324 ACPI_IMPLICIT_CONVERSION
);
329 /* Storing to an Index (pointer into a packager or buffer) */
332 acpi_ex_store_object_to_index(source_desc
, ref_desc
,
339 /* Store to a method local/arg */
342 acpi_ds_store_object_to_local(ref_desc
->reference
.opcode
,
343 ref_desc
->reference
.offset
,
344 source_desc
, walk_state
);
350 * Storing to the Debug object causes the value stored to be
351 * displayed and otherwise has no effect -- see ACPI Specification
353 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
354 "**** Write to Debug Object: Object %p %s ****:\n\n",
356 acpi_ut_get_object_type_name(source_desc
)));
358 acpi_ex_do_debug_object(source_desc
, 0, 0);
363 ACPI_ERROR((AE_INFO
, "Unknown Reference opcode %X",
364 ref_desc
->reference
.opcode
));
365 ACPI_DUMP_ENTRY(ref_desc
, ACPI_LV_ERROR
);
367 status
= AE_AML_INTERNAL
;
371 return_ACPI_STATUS(status
);
374 /*******************************************************************************
376 * FUNCTION: acpi_ex_store_object_to_index
378 * PARAMETERS: *source_desc - Value to be stored
379 * *dest_desc - Named object to receive the value
380 * walk_state - Current walk state
384 * DESCRIPTION: Store the object to indexed Buffer or Package element
386 ******************************************************************************/
389 acpi_ex_store_object_to_index(union acpi_operand_object
*source_desc
,
390 union acpi_operand_object
*index_desc
,
391 struct acpi_walk_state
*walk_state
)
393 acpi_status status
= AE_OK
;
394 union acpi_operand_object
*obj_desc
;
395 union acpi_operand_object
*new_desc
;
399 ACPI_FUNCTION_TRACE(ex_store_object_to_index
);
402 * Destination must be a reference pointer, and
403 * must point to either a buffer or a package
405 switch (index_desc
->reference
.target_type
) {
406 case ACPI_TYPE_PACKAGE
:
408 * Storing to a package element. Copy the object and replace
409 * any existing object with the new object. No implicit
410 * conversion is performed.
412 * The object at *(index_desc->Reference.Where) is the
413 * element within the package that is to be modified.
414 * The parent package object is at index_desc->Reference.Object
416 obj_desc
= *(index_desc
->reference
.where
);
419 acpi_ut_copy_iobject_to_iobject(source_desc
, &new_desc
,
421 if (ACPI_FAILURE(status
)) {
422 return_ACPI_STATUS(status
);
427 /* Decrement reference count by the ref count of the parent package */
429 for (i
= 0; i
< ((union acpi_operand_object
*)
430 index_desc
->reference
.object
)->common
.
431 reference_count
; i
++) {
432 acpi_ut_remove_reference(obj_desc
);
436 *(index_desc
->reference
.where
) = new_desc
;
438 /* Increment ref count by the ref count of the parent package-1 */
440 for (i
= 1; i
< ((union acpi_operand_object
*)
441 index_desc
->reference
.object
)->common
.
442 reference_count
; i
++) {
443 acpi_ut_add_reference(new_desc
);
448 case ACPI_TYPE_BUFFER_FIELD
:
451 * Store into a Buffer or String (not actually a real buffer_field)
452 * at a location defined by an Index.
454 * The first 8-bit element of the source object is written to the
455 * 8-bit Buffer location defined by the Index destination object,
456 * according to the ACPI 2.0 specification.
460 * Make sure the target is a Buffer or String. An error should
461 * not happen here, since the reference_object was constructed
462 * by the INDEX_OP code.
464 obj_desc
= index_desc
->reference
.object
;
465 if ((ACPI_GET_OBJECT_TYPE(obj_desc
) != ACPI_TYPE_BUFFER
) &&
466 (ACPI_GET_OBJECT_TYPE(obj_desc
) != ACPI_TYPE_STRING
)) {
467 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
471 * The assignment of the individual elements will be slightly
472 * different for each source type.
474 switch (ACPI_GET_OBJECT_TYPE(source_desc
)) {
475 case ACPI_TYPE_INTEGER
:
477 /* Use the least-significant byte of the integer */
479 value
= (u8
) (source_desc
->integer
.value
);
482 case ACPI_TYPE_BUFFER
:
483 case ACPI_TYPE_STRING
:
485 /* Note: Takes advantage of common string/buffer fields */
487 value
= source_desc
->buffer
.pointer
[0];
492 /* All other types are invalid */
495 "Source must be Integer/Buffer/String type, not %s",
496 acpi_ut_get_object_type_name(source_desc
)));
497 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
500 /* Store the source value into the target buffer byte */
502 obj_desc
->buffer
.pointer
[index_desc
->reference
.offset
] = value
;
506 ACPI_ERROR((AE_INFO
, "Target is not a Package or BufferField"));
507 status
= AE_AML_OPERAND_TYPE
;
511 return_ACPI_STATUS(status
);
514 /*******************************************************************************
516 * FUNCTION: acpi_ex_store_object_to_node
518 * PARAMETERS: source_desc - Value to be stored
519 * Node - Named object to receive the value
520 * walk_state - Current walk state
521 * implicit_conversion - Perform implicit conversion (yes/no)
525 * DESCRIPTION: Store the object to the named object.
527 * The Assignment of an object to a named object is handled here
528 * The value passed in will replace the current value (if any)
529 * with the input value.
531 * When storing into an object the data is converted to the
532 * target object type then stored in the object. This means
533 * that the target object type (for an initialized target) will
534 * not be changed by a store operation.
536 * Assumes parameters are already validated.
538 ******************************************************************************/
541 acpi_ex_store_object_to_node(union acpi_operand_object
*source_desc
,
542 struct acpi_namespace_node
*node
,
543 struct acpi_walk_state
*walk_state
,
544 u8 implicit_conversion
)
546 acpi_status status
= AE_OK
;
547 union acpi_operand_object
*target_desc
;
548 union acpi_operand_object
*new_desc
;
549 acpi_object_type target_type
;
551 ACPI_FUNCTION_TRACE_PTR(ex_store_object_to_node
, source_desc
);
553 /* Get current type of the node, and object attached to Node */
555 target_type
= acpi_ns_get_type(node
);
556 target_desc
= acpi_ns_get_attached_object(node
);
558 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Storing %p(%s) into node %p(%s)\n",
560 acpi_ut_get_object_type_name(source_desc
), node
,
561 acpi_ut_get_type_name(target_type
)));
564 * Resolve the source object to an actual value
565 * (If it is a reference object)
567 status
= acpi_ex_resolve_object(&source_desc
, target_type
, walk_state
);
568 if (ACPI_FAILURE(status
)) {
569 return_ACPI_STATUS(status
);
572 /* If no implicit conversion, drop into the default case below */
574 if ((!implicit_conversion
) || (walk_state
->opcode
== AML_COPY_OP
)) {
576 /* Force execution of default (no implicit conversion) */
578 target_type
= ACPI_TYPE_ANY
;
581 /* Do the actual store operation */
583 switch (target_type
) {
584 case ACPI_TYPE_BUFFER_FIELD
:
585 case ACPI_TYPE_LOCAL_REGION_FIELD
:
586 case ACPI_TYPE_LOCAL_BANK_FIELD
:
587 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
589 /* For fields, copy the source data to the target field. */
591 status
= acpi_ex_write_data_to_field(source_desc
, target_desc
,
592 &walk_state
->result_obj
);
595 case ACPI_TYPE_INTEGER
:
596 case ACPI_TYPE_STRING
:
597 case ACPI_TYPE_BUFFER
:
600 * These target types are all of type Integer/String/Buffer, and
601 * therefore support implicit conversion before the store.
603 * Copy and/or convert the source object to a new target object
606 acpi_ex_store_object_to_object(source_desc
, target_desc
,
607 &new_desc
, walk_state
);
608 if (ACPI_FAILURE(status
)) {
609 return_ACPI_STATUS(status
);
612 if (new_desc
!= target_desc
) {
614 * Store the new new_desc as the new value of the Name, and set
615 * the Name's type to that of the value being stored in it.
616 * source_desc reference count is incremented by attach_object.
618 * Note: This may change the type of the node if an explicit store
619 * has been performed such that the node/object type has been
623 acpi_ns_attach_object(node
, new_desc
,
624 new_desc
->common
.type
);
626 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
627 "Store %s into %s via Convert/Attach\n",
628 acpi_ut_get_object_type_name
630 acpi_ut_get_object_type_name
637 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
638 "Storing %s (%p) directly into node (%p) with no implicit conversion\n",
639 acpi_ut_get_object_type_name(source_desc
),
642 /* No conversions for all other types. Just attach the source object */
644 status
= acpi_ns_attach_object(node
, source_desc
,
650 return_ACPI_STATUS(status
);