1 /******************************************************************************
3 * Module Name: utcopy - Internal to external object translation utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, 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/amlcode.h>
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utcopy")
50 /* Local prototypes */
52 acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
53 union acpi_object *external_object,
54 u8 * data_space, acpi_size * buffer_space_used);
57 acpi_ut_copy_ielement_to_ielement(u8 object_type,
58 union acpi_operand_object *source_object,
59 union acpi_generic_state *state,
63 acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
64 u8 * buffer, acpi_size * space_used);
67 acpi_ut_copy_esimple_to_isimple(union acpi_object *user_obj,
68 union acpi_operand_object **return_obj);
71 acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
72 union acpi_operand_object **internal_object);
75 acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
76 union acpi_operand_object *dest_desc);
79 acpi_ut_copy_ielement_to_eelement(u8 object_type,
80 union acpi_operand_object *source_object,
81 union acpi_generic_state *state,
85 acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
86 union acpi_operand_object *dest_obj,
87 struct acpi_walk_state *walk_state);
89 /*******************************************************************************
91 * FUNCTION: acpi_ut_copy_isimple_to_esimple
93 * PARAMETERS: internal_object - Source object to be copied
94 * external_object - Where to return the copied object
95 * data_space - Where object data is returned (such as
96 * buffer and string data)
97 * buffer_space_used - Length of data_space that was used
101 * DESCRIPTION: This function is called to copy a simple internal object to
102 * an external object.
104 * The data_space buffer is assumed to have sufficient space for
107 ******************************************************************************/
110 acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
111 union acpi_object *external_object,
112 u8 * data_space, acpi_size * buffer_space_used)
114 acpi_status status = AE_OK;
116 ACPI_FUNCTION_TRACE(ut_copy_isimple_to_esimple);
118 *buffer_space_used = 0;
121 * Check for NULL object case (could be an uninitialized
124 if (!internal_object) {
125 return_ACPI_STATUS(AE_OK);
128 /* Always clear the external object */
130 ACPI_MEMSET(external_object, 0, sizeof(union acpi_object));
133 * In general, the external object will be the same type as
134 * the internal object
136 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
138 /* However, only a limited number of external types are supported */
140 switch (ACPI_GET_OBJECT_TYPE(internal_object)) {
141 case ACPI_TYPE_STRING:
143 external_object->string.pointer = (char *)data_space;
144 external_object->string.length = internal_object->string.length;
145 *buffer_space_used = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
150 ACPI_MEMCPY((void *)data_space,
151 (void *)internal_object->string.pointer,
152 (acpi_size) internal_object->string.length + 1);
155 case ACPI_TYPE_BUFFER:
157 external_object->buffer.pointer = data_space;
158 external_object->buffer.length = internal_object->buffer.length;
160 ACPI_ROUND_UP_TO_NATIVE_WORD(internal_object->string.
163 ACPI_MEMCPY((void *)data_space,
164 (void *)internal_object->buffer.pointer,
165 internal_object->buffer.length);
168 case ACPI_TYPE_INTEGER:
170 external_object->integer.value = internal_object->integer.value;
173 case ACPI_TYPE_LOCAL_REFERENCE:
176 * This is an object reference. Attempt to dereference it.
178 switch (internal_object->reference.opcode) {
179 case AML_INT_NAMEPATH_OP:
181 /* For namepath, return the object handle ("reference") */
185 * Use the object type of "Any" to indicate a reference
186 * to object containing a handle to an ACPI named object.
188 external_object->type = ACPI_TYPE_ANY;
189 external_object->reference.handle =
190 internal_object->reference.node;
195 case ACPI_TYPE_PROCESSOR:
197 external_object->processor.proc_id =
198 internal_object->processor.proc_id;
199 external_object->processor.pblk_address =
200 internal_object->processor.address;
201 external_object->processor.pblk_length =
202 internal_object->processor.length;
205 case ACPI_TYPE_POWER:
207 external_object->power_resource.system_level =
208 internal_object->power_resource.system_level;
210 external_object->power_resource.resource_order =
211 internal_object->power_resource.resource_order;
216 * There is no corresponding external object type
219 "Unsupported object type, cannot convert to external object: %s",
220 acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE
221 (internal_object))));
223 return_ACPI_STATUS(AE_SUPPORT);
226 return_ACPI_STATUS(status);
229 /*******************************************************************************
231 * FUNCTION: acpi_ut_copy_ielement_to_eelement
233 * PARAMETERS: acpi_pkg_callback
237 * DESCRIPTION: Copy one package element to another package element
239 ******************************************************************************/
242 acpi_ut_copy_ielement_to_eelement(u8 object_type,
243 union acpi_operand_object *source_object,
244 union acpi_generic_state *state,
247 acpi_status status = AE_OK;
248 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
249 acpi_size object_space;
251 union acpi_object *target_object;
253 ACPI_FUNCTION_ENTRY();
255 this_index = state->pkg.index;
256 target_object = (union acpi_object *)
257 &((union acpi_object *)(state->pkg.dest_object))->package.
258 elements[this_index];
260 switch (object_type) {
261 case ACPI_COPY_TYPE_SIMPLE:
264 * This is a simple or null object
266 status = acpi_ut_copy_isimple_to_esimple(source_object,
270 if (ACPI_FAILURE(status)) {
275 case ACPI_COPY_TYPE_PACKAGE:
278 * Build the package object
280 target_object->type = ACPI_TYPE_PACKAGE;
281 target_object->package.count = source_object->package.count;
282 target_object->package.elements =
283 ACPI_CAST_PTR(union acpi_object, info->free_space);
286 * Pass the new package object back to the package walk routine
288 state->pkg.this_target_obj = target_object;
291 * Save space for the array of objects (Package elements)
292 * update the buffer length counter
294 object_space = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
302 return (AE_BAD_PARAMETER);
305 info->free_space += object_space;
306 info->length += object_space;
310 /*******************************************************************************
312 * FUNCTION: acpi_ut_copy_ipackage_to_epackage
314 * PARAMETERS: internal_object - Pointer to the object we are returning
315 * Buffer - Where the object is returned
316 * space_used - Where the object length is returned
320 * DESCRIPTION: This function is called to place a package object in a user
321 * buffer. A package object by definition contains other objects.
323 * The buffer is assumed to have sufficient space for the object.
324 * The caller must have verified the buffer length needed using the
325 * acpi_ut_get_object_size function before calling this function.
327 ******************************************************************************/
330 acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
331 u8 * buffer, acpi_size * space_used)
333 union acpi_object *external_object;
335 struct acpi_pkg_info info;
337 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_epackage);
340 * First package at head of the buffer
342 external_object = ACPI_CAST_PTR(union acpi_object, buffer);
345 * Free space begins right after the first package
347 info.length = ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
349 buffer + ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
350 info.object_space = 0;
351 info.num_packages = 1;
353 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
354 external_object->package.count = internal_object->package.count;
355 external_object->package.elements = ACPI_CAST_PTR(union acpi_object,
359 * Leave room for an array of ACPI_OBJECTS in the buffer
360 * and move the free space past it
362 info.length += (acpi_size) external_object->package.count *
363 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
364 info.free_space += external_object->package.count *
365 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
367 status = acpi_ut_walk_package_tree(internal_object, external_object,
368 acpi_ut_copy_ielement_to_eelement,
371 *space_used = info.length;
372 return_ACPI_STATUS(status);
375 /*******************************************************************************
377 * FUNCTION: acpi_ut_copy_iobject_to_eobject
379 * PARAMETERS: internal_object - The internal object to be converted
380 * buffer_ptr - Where the object is returned
384 * DESCRIPTION: This function is called to build an API object to be returned to
387 ******************************************************************************/
390 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *internal_object,
391 struct acpi_buffer *ret_buffer)
395 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_eobject);
397 if (ACPI_GET_OBJECT_TYPE(internal_object) == ACPI_TYPE_PACKAGE) {
399 * Package object: Copy all subobjects (including
402 status = acpi_ut_copy_ipackage_to_epackage(internal_object,
404 &ret_buffer->length);
407 * Build a simple object (no nested objects)
409 status = acpi_ut_copy_isimple_to_esimple(internal_object,
417 ACPI_ROUND_UP_TO_NATIVE_WORD
421 &ret_buffer->length);
423 * build simple does not include the object size in the length
424 * so we add it in here
426 ret_buffer->length += sizeof(union acpi_object);
429 return_ACPI_STATUS(status);
432 /*******************************************************************************
434 * FUNCTION: acpi_ut_copy_esimple_to_isimple
436 * PARAMETERS: external_object - The external object to be converted
437 * ret_internal_object - Where the internal object is returned
441 * DESCRIPTION: This function copies an external object to an internal one.
442 * NOTE: Pointers can be copied, we don't need to copy data.
443 * (The pointers have to be valid in our address space no matter
444 * what we do with them!)
446 ******************************************************************************/
449 acpi_ut_copy_esimple_to_isimple(union acpi_object *external_object,
450 union acpi_operand_object **ret_internal_object)
452 union acpi_operand_object *internal_object;
454 ACPI_FUNCTION_TRACE(ut_copy_esimple_to_isimple);
457 * Simple types supported are: String, Buffer, Integer
459 switch (external_object->type) {
460 case ACPI_TYPE_STRING:
461 case ACPI_TYPE_BUFFER:
462 case ACPI_TYPE_INTEGER:
464 internal_object = acpi_ut_create_internal_object((u8)
467 if (!internal_object) {
468 return_ACPI_STATUS(AE_NO_MEMORY);
473 /* All other types are not supported */
476 "Unsupported object type, cannot convert to internal object: %s",
477 acpi_ut_get_type_name(external_object->type)));
479 return_ACPI_STATUS(AE_SUPPORT);
482 /* Must COPY string and buffer contents */
484 switch (external_object->type) {
485 case ACPI_TYPE_STRING:
487 internal_object->string.pointer =
488 ACPI_ALLOCATE_ZEROED((acpi_size) external_object->string.
490 if (!internal_object->string.pointer) {
494 ACPI_MEMCPY(internal_object->string.pointer,
495 external_object->string.pointer,
496 external_object->string.length);
498 internal_object->string.length = external_object->string.length;
501 case ACPI_TYPE_BUFFER:
503 internal_object->buffer.pointer =
504 ACPI_ALLOCATE_ZEROED(external_object->buffer.length);
505 if (!internal_object->buffer.pointer) {
509 ACPI_MEMCPY(internal_object->buffer.pointer,
510 external_object->buffer.pointer,
511 external_object->buffer.length);
513 internal_object->buffer.length = external_object->buffer.length;
516 case ACPI_TYPE_INTEGER:
518 internal_object->integer.value = external_object->integer.value;
522 /* Other types can't get here */
526 *ret_internal_object = internal_object;
527 return_ACPI_STATUS(AE_OK);
530 acpi_ut_remove_reference(internal_object);
531 return_ACPI_STATUS(AE_NO_MEMORY);
534 /*******************************************************************************
536 * FUNCTION: acpi_ut_copy_epackage_to_ipackage
538 * PARAMETERS: external_object - The external object to be converted
539 * internal_object - Where the internal object is returned
543 * DESCRIPTION: Copy an external package object to an internal package.
544 * Handles nested packages.
546 ******************************************************************************/
549 acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
550 union acpi_operand_object **internal_object)
552 acpi_status status = AE_OK;
553 union acpi_operand_object *package_object;
554 union acpi_operand_object **package_elements;
557 ACPI_FUNCTION_TRACE(ut_copy_epackage_to_ipackage);
559 /* Create the package object */
562 acpi_ut_create_package_object(external_object->package.count);
563 if (!package_object) {
564 return_ACPI_STATUS(AE_NO_MEMORY);
567 package_elements = package_object->package.elements;
570 * Recursive implementation. Probably ok, since nested external packages
571 * as parameters should be very rare.
573 for (i = 0; i < external_object->package.count; i++) {
575 acpi_ut_copy_eobject_to_iobject(&external_object->package.
577 &package_elements[i]);
578 if (ACPI_FAILURE(status)) {
580 /* Truncate package and delete it */
582 package_object->package.count = (u32) i;
583 package_elements[i] = NULL;
584 acpi_ut_remove_reference(package_object);
585 return_ACPI_STATUS(status);
589 *internal_object = package_object;
590 return_ACPI_STATUS(status);
593 /*******************************************************************************
595 * FUNCTION: acpi_ut_copy_eobject_to_iobject
597 * PARAMETERS: external_object - The external object to be converted
598 * internal_object - Where the internal object is returned
600 * RETURN: Status - the status of the call
602 * DESCRIPTION: Converts an external object to an internal object.
604 ******************************************************************************/
607 acpi_ut_copy_eobject_to_iobject(union acpi_object *external_object,
608 union acpi_operand_object **internal_object)
612 ACPI_FUNCTION_TRACE(ut_copy_eobject_to_iobject);
614 if (external_object->type == ACPI_TYPE_PACKAGE) {
616 acpi_ut_copy_epackage_to_ipackage(external_object,
620 * Build a simple object (no nested objects)
623 acpi_ut_copy_esimple_to_isimple(external_object,
627 return_ACPI_STATUS(status);
630 /*******************************************************************************
632 * FUNCTION: acpi_ut_copy_simple_object
634 * PARAMETERS: source_desc - The internal object to be copied
635 * dest_desc - New target object
639 * DESCRIPTION: Simple copy of one internal object to another. Reference count
640 * of the destination object is preserved.
642 ******************************************************************************/
645 acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
646 union acpi_operand_object *dest_desc)
649 union acpi_operand_object *next_object;
651 /* Save fields from destination that we don't want to overwrite */
653 reference_count = dest_desc->common.reference_count;
654 next_object = dest_desc->common.next_object;
656 /* Copy the entire source object over the destination object */
658 ACPI_MEMCPY((char *)dest_desc, (char *)source_desc,
659 sizeof(union acpi_operand_object));
661 /* Restore the saved fields */
663 dest_desc->common.reference_count = reference_count;
664 dest_desc->common.next_object = next_object;
666 /* New object is not static, regardless of source */
668 dest_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
670 /* Handle the objects with extra data */
672 switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
673 case ACPI_TYPE_BUFFER:
675 * Allocate and copy the actual buffer if and only if:
676 * 1) There is a valid buffer pointer
677 * 2) The buffer has a length > 0
679 if ((source_desc->buffer.pointer) &&
680 (source_desc->buffer.length)) {
681 dest_desc->buffer.pointer =
682 ACPI_ALLOCATE(source_desc->buffer.length);
683 if (!dest_desc->buffer.pointer) {
684 return (AE_NO_MEMORY);
687 /* Copy the actual buffer data */
689 ACPI_MEMCPY(dest_desc->buffer.pointer,
690 source_desc->buffer.pointer,
691 source_desc->buffer.length);
695 case ACPI_TYPE_STRING:
697 * Allocate and copy the actual string if and only if:
698 * 1) There is a valid string pointer
699 * (Pointer to a NULL string is allowed)
701 if (source_desc->string.pointer) {
702 dest_desc->string.pointer =
703 ACPI_ALLOCATE((acpi_size) source_desc->string.
705 if (!dest_desc->string.pointer) {
706 return (AE_NO_MEMORY);
709 /* Copy the actual string data */
711 ACPI_MEMCPY(dest_desc->string.pointer,
712 source_desc->string.pointer,
713 (acpi_size) source_desc->string.length + 1);
717 case ACPI_TYPE_LOCAL_REFERENCE:
719 * We copied the reference object, so we now must add a reference
720 * to the object pointed to by the reference
722 * DDBHandle reference (from Load/load_table is a special reference,
723 * it's Reference.Object is the table index, so does not need to
724 * increase the reference count
726 if (source_desc->reference.opcode == AML_LOAD_OP) {
730 acpi_ut_add_reference(source_desc->reference.object);
733 case ACPI_TYPE_REGION:
735 * We copied the Region Handler, so we now must add a reference
737 if (dest_desc->region.handler) {
738 acpi_ut_add_reference(dest_desc->region.handler);
743 /* Nothing to do for other simple objects */
750 /*******************************************************************************
752 * FUNCTION: acpi_ut_copy_ielement_to_ielement
754 * PARAMETERS: acpi_pkg_callback
758 * DESCRIPTION: Copy one package element to another package element
760 ******************************************************************************/
763 acpi_ut_copy_ielement_to_ielement(u8 object_type,
764 union acpi_operand_object *source_object,
765 union acpi_generic_state *state,
768 acpi_status status = AE_OK;
770 union acpi_operand_object **this_target_ptr;
771 union acpi_operand_object *target_object;
773 ACPI_FUNCTION_ENTRY();
775 this_index = state->pkg.index;
776 this_target_ptr = (union acpi_operand_object **)
777 &state->pkg.dest_object->package.elements[this_index];
779 switch (object_type) {
780 case ACPI_COPY_TYPE_SIMPLE:
782 /* A null source object indicates a (legal) null package element */
786 * This is a simple object, just copy it
789 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE
791 if (!target_object) {
792 return (AE_NO_MEMORY);
796 acpi_ut_copy_simple_object(source_object,
798 if (ACPI_FAILURE(status)) {
802 *this_target_ptr = target_object;
804 /* Pass through a null element */
806 *this_target_ptr = NULL;
810 case ACPI_COPY_TYPE_PACKAGE:
813 * This object is a package - go down another nesting level
814 * Create and build the package object
817 acpi_ut_create_package_object(source_object->package.count);
818 if (!target_object) {
819 return (AE_NO_MEMORY);
822 target_object->common.flags = source_object->common.flags;
824 /* Pass the new package object back to the package walk routine */
826 state->pkg.this_target_obj = target_object;
828 /* Store the object pointer in the parent package object */
830 *this_target_ptr = target_object;
834 return (AE_BAD_PARAMETER);
840 acpi_ut_remove_reference(target_object);
844 /*******************************************************************************
846 * FUNCTION: acpi_ut_copy_ipackage_to_ipackage
848 * PARAMETERS: *source_obj - Pointer to the source package object
849 * *dest_obj - Where the internal object is returned
851 * RETURN: Status - the status of the call
853 * DESCRIPTION: This function is called to copy an internal package object
854 * into another internal package object.
856 ******************************************************************************/
859 acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
860 union acpi_operand_object *dest_obj,
861 struct acpi_walk_state *walk_state)
863 acpi_status status = AE_OK;
865 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_ipackage);
867 dest_obj->common.type = ACPI_GET_OBJECT_TYPE(source_obj);
868 dest_obj->common.flags = source_obj->common.flags;
869 dest_obj->package.count = source_obj->package.count;
872 * Create the object array and walk the source package tree
874 dest_obj->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
877 1) * sizeof(void *));
878 if (!dest_obj->package.elements) {
879 ACPI_ERROR((AE_INFO, "Package allocation failure"));
880 return_ACPI_STATUS(AE_NO_MEMORY);
884 * Copy the package element-by-element by walking the package "tree".
885 * This handles nested packages of arbitrary depth.
887 status = acpi_ut_walk_package_tree(source_obj, dest_obj,
888 acpi_ut_copy_ielement_to_ielement,
890 if (ACPI_FAILURE(status)) {
892 /* On failure, delete the destination package object */
894 acpi_ut_remove_reference(dest_obj);
897 return_ACPI_STATUS(status);
900 /*******************************************************************************
902 * FUNCTION: acpi_ut_copy_iobject_to_iobject
904 * PARAMETERS: walk_state - Current walk state
905 * source_desc - The internal object to be copied
906 * dest_desc - Where the copied object is returned
910 * DESCRIPTION: Copy an internal object to a new internal object
912 ******************************************************************************/
915 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
916 union acpi_operand_object **dest_desc,
917 struct acpi_walk_state *walk_state)
919 acpi_status status = AE_OK;
921 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_iobject);
923 /* Create the top level object */
926 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE(source_desc));
928 return_ACPI_STATUS(AE_NO_MEMORY);
931 /* Copy the object and possible subobjects */
933 if (ACPI_GET_OBJECT_TYPE(source_desc) == ACPI_TYPE_PACKAGE) {
935 acpi_ut_copy_ipackage_to_ipackage(source_desc, *dest_desc,
938 status = acpi_ut_copy_simple_object(source_desc, *dest_desc);
941 return_ACPI_STATUS(status);