hugetlb: make unmap_ref_private multi-size-aware
[zen-stable.git] / drivers / acpi / executer / exstore.c
blob3318df4cbd989191fc46de95e3cbd209ccf0f525
2 /******************************************************************************
4 * Module Name: exstore - AML Interpreter object store support
6 *****************************************************************************/
8 /*
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
14 * are met:
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.
31 * NO WARRANTY
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>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exstore")
54 /* Local prototypes */
55 static void
56 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
57 u32 level, u32 index);
59 static acpi_status
60 acpi_ex_store_object_to_index(union acpi_operand_object *val_desc,
61 union acpi_operand_object *dest_desc,
62 struct acpi_walk_state *walk_state);
64 /*******************************************************************************
66 * FUNCTION: acpi_ex_do_debug_object
68 * PARAMETERS: source_desc - Value to be stored
69 * Level - Indentation level (used for packages)
70 * Index - Current package element, zero if not pkg
72 * RETURN: None
74 * DESCRIPTION: Handles stores to the Debug Object.
76 ******************************************************************************/
78 static void
79 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
80 u32 level, u32 index)
82 u32 i;
84 ACPI_FUNCTION_TRACE_PTR(ex_do_debug_object, source_desc);
86 /* Print line header as long as we are not in the middle of an object display */
88 if (!((level > 0) && index == 0)) {
89 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[ACPI Debug] %*s",
90 level, " "));
93 /* Display index for package output only */
95 if (index > 0) {
96 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
97 "(%.2u) ", index - 1));
100 if (!source_desc) {
101 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[Null Object]\n"));
102 return_VOID;
105 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_OPERAND) {
106 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%s ",
107 acpi_ut_get_object_type_name
108 (source_desc)));
110 if (!acpi_ut_valid_internal_object(source_desc)) {
111 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
112 "%p, Invalid Internal Object!\n",
113 source_desc));
114 return_VOID;
116 } else if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) ==
117 ACPI_DESC_TYPE_NAMED) {
118 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%s: %p\n",
119 acpi_ut_get_type_name(((struct
120 acpi_namespace_node
121 *)source_desc)->
122 type),
123 source_desc));
124 return_VOID;
125 } else {
126 return_VOID;
129 /* source_desc is of type ACPI_DESC_TYPE_OPERAND */
131 switch (ACPI_GET_OBJECT_TYPE(source_desc)) {
132 case ACPI_TYPE_INTEGER:
134 /* Output correct integer width */
136 if (acpi_gbl_integer_byte_width == 4) {
137 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "0x%8.8X\n",
138 (u32) source_desc->integer.
139 value));
140 } else {
141 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
142 "0x%8.8X%8.8X\n",
143 ACPI_FORMAT_UINT64(source_desc->
144 integer.
145 value)));
147 break;
149 case ACPI_TYPE_BUFFER:
151 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[0x%.2X]\n",
152 (u32) source_desc->buffer.length));
153 ACPI_DUMP_BUFFER(source_desc->buffer.pointer,
154 (source_desc->buffer.length <
155 256) ? source_desc->buffer.length : 256);
156 break;
158 case ACPI_TYPE_STRING:
160 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[0x%.2X] \"%s\"\n",
161 source_desc->string.length,
162 source_desc->string.pointer));
163 break;
165 case ACPI_TYPE_PACKAGE:
167 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
168 "[Contains 0x%.2X Elements]\n",
169 source_desc->package.count));
171 /* Output the entire contents of the package */
173 for (i = 0; i < source_desc->package.count; i++) {
174 acpi_ex_do_debug_object(source_desc->package.
175 elements[i], level + 4, i + 1);
177 break;
179 case ACPI_TYPE_LOCAL_REFERENCE:
181 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "[%s] ",
182 acpi_ut_get_reference_name(source_desc)));
184 /* Decode the reference */
186 switch (source_desc->reference.class) {
187 case ACPI_REFCLASS_INDEX:
189 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "0x%X\n",
190 source_desc->reference.value));
191 break;
193 case ACPI_REFCLASS_TABLE:
195 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
196 "Table Index 0x%X\n",
197 source_desc->reference.value));
198 break;
200 default:
201 break;
204 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, " "));
206 /* Check for valid node first, then valid object */
208 if (source_desc->reference.node) {
209 if (ACPI_GET_DESCRIPTOR_TYPE
210 (source_desc->reference.node) !=
211 ACPI_DESC_TYPE_NAMED) {
212 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
213 " %p - Not a valid namespace node\n",
214 source_desc->reference.
215 node));
216 } else {
217 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT,
218 "Node %p [%4.4s] ",
219 source_desc->reference.
220 node,
221 (source_desc->reference.
222 node)->name.ascii));
224 switch ((source_desc->reference.node)->type) {
226 /* These types have no attached object */
228 case ACPI_TYPE_DEVICE:
229 acpi_os_printf("Device\n");
230 break;
232 case ACPI_TYPE_THERMAL:
233 acpi_os_printf("Thermal Zone\n");
234 break;
236 default:
237 acpi_ex_do_debug_object((source_desc->
238 reference.
239 node)->object,
240 level + 4, 0);
241 break;
244 } else if (source_desc->reference.object) {
245 if (ACPI_GET_DESCRIPTOR_TYPE
246 (source_desc->reference.object) ==
247 ACPI_DESC_TYPE_NAMED) {
248 acpi_ex_do_debug_object(((struct
249 acpi_namespace_node *)
250 source_desc->reference.
251 object)->object,
252 level + 4, 0);
253 } else {
254 acpi_ex_do_debug_object(source_desc->reference.
255 object, level + 4, 0);
258 break;
260 default:
262 ACPI_DEBUG_PRINT_RAW((ACPI_DB_DEBUG_OBJECT, "%p\n",
263 source_desc));
264 break;
267 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "\n"));
268 return_VOID;
271 /*******************************************************************************
273 * FUNCTION: acpi_ex_store
275 * PARAMETERS: *source_desc - Value to be stored
276 * *dest_desc - Where to store it. Must be an NS node
277 * or an union acpi_operand_object of type
278 * Reference;
279 * walk_state - Current walk state
281 * RETURN: Status
283 * DESCRIPTION: Store the value described by source_desc into the location
284 * described by dest_desc. Called by various interpreter
285 * functions to store the result of an operation into
286 * the destination operand -- not just simply the actual "Store"
287 * ASL operator.
289 ******************************************************************************/
291 acpi_status
292 acpi_ex_store(union acpi_operand_object *source_desc,
293 union acpi_operand_object *dest_desc,
294 struct acpi_walk_state *walk_state)
296 acpi_status status = AE_OK;
297 union acpi_operand_object *ref_desc = dest_desc;
299 ACPI_FUNCTION_TRACE_PTR(ex_store, dest_desc);
301 /* Validate parameters */
303 if (!source_desc || !dest_desc) {
304 ACPI_ERROR((AE_INFO, "Null parameter"));
305 return_ACPI_STATUS(AE_AML_NO_OPERAND);
308 /* dest_desc can be either a namespace node or an ACPI object */
310 if (ACPI_GET_DESCRIPTOR_TYPE(dest_desc) == ACPI_DESC_TYPE_NAMED) {
312 * Dest is a namespace node,
313 * Storing an object into a Named node.
315 status = acpi_ex_store_object_to_node(source_desc,
316 (struct
317 acpi_namespace_node *)
318 dest_desc, walk_state,
319 ACPI_IMPLICIT_CONVERSION);
321 return_ACPI_STATUS(status);
324 /* Destination object must be a Reference or a Constant object */
326 switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
327 case ACPI_TYPE_LOCAL_REFERENCE:
328 break;
330 case ACPI_TYPE_INTEGER:
332 /* Allow stores to Constants -- a Noop as per ACPI spec */
334 if (dest_desc->common.flags & AOPOBJ_AML_CONSTANT) {
335 return_ACPI_STATUS(AE_OK);
338 /*lint -fallthrough */
340 default:
342 /* Destination is not a Reference object */
344 ACPI_ERROR((AE_INFO,
345 "Target is not a Reference or Constant object - %s [%p]",
346 acpi_ut_get_object_type_name(dest_desc),
347 dest_desc));
349 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
353 * Examine the Reference class. These cases are handled:
355 * 1) Store to Name (Change the object associated with a name)
356 * 2) Store to an indexed area of a Buffer or Package
357 * 3) Store to a Method Local or Arg
358 * 4) Store to the debug object
360 switch (ref_desc->reference.class) {
361 case ACPI_REFCLASS_REFOF:
363 /* Storing an object into a Name "container" */
365 status = acpi_ex_store_object_to_node(source_desc,
366 ref_desc->reference.
367 object, walk_state,
368 ACPI_IMPLICIT_CONVERSION);
369 break;
371 case ACPI_REFCLASS_INDEX:
373 /* Storing to an Index (pointer into a packager or buffer) */
375 status =
376 acpi_ex_store_object_to_index(source_desc, ref_desc,
377 walk_state);
378 break;
380 case ACPI_REFCLASS_LOCAL:
381 case ACPI_REFCLASS_ARG:
383 /* Store to a method local/arg */
385 status =
386 acpi_ds_store_object_to_local(ref_desc->reference.class,
387 ref_desc->reference.value,
388 source_desc, walk_state);
389 break;
391 case ACPI_REFCLASS_DEBUG:
394 * Storing to the Debug object causes the value stored to be
395 * displayed and otherwise has no effect -- see ACPI Specification
397 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
398 "**** Write to Debug Object: Object %p %s ****:\n\n",
399 source_desc,
400 acpi_ut_get_object_type_name(source_desc)));
402 acpi_ex_do_debug_object(source_desc, 0, 0);
403 break;
405 default:
407 ACPI_ERROR((AE_INFO, "Unknown Reference Class %2.2X",
408 ref_desc->reference.class));
409 ACPI_DUMP_ENTRY(ref_desc, ACPI_LV_INFO);
411 status = AE_AML_INTERNAL;
412 break;
415 return_ACPI_STATUS(status);
418 /*******************************************************************************
420 * FUNCTION: acpi_ex_store_object_to_index
422 * PARAMETERS: *source_desc - Value to be stored
423 * *dest_desc - Named object to receive the value
424 * walk_state - Current walk state
426 * RETURN: Status
428 * DESCRIPTION: Store the object to indexed Buffer or Package element
430 ******************************************************************************/
432 static acpi_status
433 acpi_ex_store_object_to_index(union acpi_operand_object *source_desc,
434 union acpi_operand_object *index_desc,
435 struct acpi_walk_state *walk_state)
437 acpi_status status = AE_OK;
438 union acpi_operand_object *obj_desc;
439 union acpi_operand_object *new_desc;
440 u8 value = 0;
441 u32 i;
443 ACPI_FUNCTION_TRACE(ex_store_object_to_index);
446 * Destination must be a reference pointer, and
447 * must point to either a buffer or a package
449 switch (index_desc->reference.target_type) {
450 case ACPI_TYPE_PACKAGE:
452 * Storing to a package element. Copy the object and replace
453 * any existing object with the new object. No implicit
454 * conversion is performed.
456 * The object at *(index_desc->Reference.Where) is the
457 * element within the package that is to be modified.
458 * The parent package object is at index_desc->Reference.Object
460 obj_desc = *(index_desc->reference.where);
462 if (ACPI_GET_OBJECT_TYPE(source_desc) ==
463 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;
470 } else {
471 /* Normal object, copy it */
473 status =
474 acpi_ut_copy_iobject_to_iobject(source_desc,
475 &new_desc,
476 walk_state);
477 if (ACPI_FAILURE(status)) {
478 return_ACPI_STATUS(status);
482 if (obj_desc) {
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);
503 break;
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 ((ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_BUFFER) &&
523 (ACPI_GET_OBJECT_TYPE(obj_desc) != 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 (ACPI_GET_OBJECT_TYPE(source_desc)) {
532 case ACPI_TYPE_INTEGER:
534 /* Use the least-significant byte of the integer */
536 value = (u8) (source_desc->integer.value);
537 break;
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];
545 break;
547 default:
549 /* All other types are invalid */
551 ACPI_ERROR((AE_INFO,
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;
560 break;
562 default:
563 ACPI_ERROR((AE_INFO, "Target is not a Package or BufferField"));
564 status = AE_AML_OPERAND_TYPE;
565 break;
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)
580 * RETURN: Status
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 ******************************************************************************/
597 acpi_status
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",
616 source_desc,
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);
657 break;
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
669 status =
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
684 * changed.
686 status =
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
693 (source_desc),
694 acpi_ut_get_object_type_name
695 (new_desc)));
697 break;
699 default:
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),
704 source_desc, node));
706 /* No conversions for all other types. Just attach the source object */
708 status = acpi_ns_attach_object(node, source_desc,
709 ACPI_GET_OBJECT_TYPE
710 (source_desc));
711 break;
714 return_ACPI_STATUS(status);