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_simple_object(union acpi_operand_object *source_desc,
72 union acpi_operand_object *dest_desc);
75 acpi_ut_copy_ielement_to_eelement(u8 object_type,
76 union acpi_operand_object *source_object,
77 union acpi_generic_state *state,
81 acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
82 union acpi_operand_object *dest_obj,
83 struct acpi_walk_state *walk_state);
85 /*******************************************************************************
87 * FUNCTION: acpi_ut_copy_isimple_to_esimple
89 * PARAMETERS: internal_object - Source object to be copied
90 * external_object - Where to return the copied object
91 * data_space - Where object data is returned (such as
92 * buffer and string data)
93 * buffer_space_used - Length of data_space that was used
97 * DESCRIPTION: This function is called to copy a simple internal object to
100 * The data_space buffer is assumed to have sufficient space for
103 ******************************************************************************/
106 acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
107 union acpi_object *external_object,
108 u8 * data_space, acpi_size * buffer_space_used)
110 acpi_status status = AE_OK;
112 ACPI_FUNCTION_TRACE(ut_copy_isimple_to_esimple);
114 *buffer_space_used = 0;
117 * Check for NULL object case (could be an uninitialized
120 if (!internal_object) {
121 return_ACPI_STATUS(AE_OK);
124 /* Always clear the external object */
126 ACPI_MEMSET(external_object, 0, sizeof(union acpi_object));
129 * In general, the external object will be the same type as
130 * the internal object
132 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
134 /* However, only a limited number of external types are supported */
136 switch (ACPI_GET_OBJECT_TYPE(internal_object)) {
137 case ACPI_TYPE_STRING:
139 external_object->string.pointer = (char *)data_space;
140 external_object->string.length = internal_object->string.length;
141 *buffer_space_used = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
146 ACPI_MEMCPY((void *)data_space,
147 (void *)internal_object->string.pointer,
148 (acpi_size) internal_object->string.length + 1);
151 case ACPI_TYPE_BUFFER:
153 external_object->buffer.pointer = data_space;
154 external_object->buffer.length = internal_object->buffer.length;
156 ACPI_ROUND_UP_TO_NATIVE_WORD(internal_object->string.
159 ACPI_MEMCPY((void *)data_space,
160 (void *)internal_object->buffer.pointer,
161 internal_object->buffer.length);
164 case ACPI_TYPE_INTEGER:
166 external_object->integer.value = internal_object->integer.value;
169 case ACPI_TYPE_LOCAL_REFERENCE:
172 * This is an object reference. Attempt to dereference it.
174 switch (internal_object->reference.opcode) {
175 case AML_INT_NAMEPATH_OP:
177 /* For namepath, return the object handle ("reference") */
181 * Use the object type of "Any" to indicate a reference
182 * to object containing a handle to an ACPI named object.
184 external_object->type = ACPI_TYPE_ANY;
185 external_object->reference.handle =
186 internal_object->reference.node;
191 case ACPI_TYPE_PROCESSOR:
193 external_object->processor.proc_id =
194 internal_object->processor.proc_id;
195 external_object->processor.pblk_address =
196 internal_object->processor.address;
197 external_object->processor.pblk_length =
198 internal_object->processor.length;
201 case ACPI_TYPE_POWER:
203 external_object->power_resource.system_level =
204 internal_object->power_resource.system_level;
206 external_object->power_resource.resource_order =
207 internal_object->power_resource.resource_order;
212 * There is no corresponding external object type
214 return_ACPI_STATUS(AE_SUPPORT);
217 return_ACPI_STATUS(status);
220 /*******************************************************************************
222 * FUNCTION: acpi_ut_copy_ielement_to_eelement
224 * PARAMETERS: acpi_pkg_callback
228 * DESCRIPTION: Copy one package element to another package element
230 ******************************************************************************/
233 acpi_ut_copy_ielement_to_eelement(u8 object_type,
234 union acpi_operand_object *source_object,
235 union acpi_generic_state *state,
238 acpi_status status = AE_OK;
239 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
240 acpi_size object_space;
242 union acpi_object *target_object;
244 ACPI_FUNCTION_ENTRY();
246 this_index = state->pkg.index;
247 target_object = (union acpi_object *)
248 &((union acpi_object *)(state->pkg.dest_object))->package.
249 elements[this_index];
251 switch (object_type) {
252 case ACPI_COPY_TYPE_SIMPLE:
255 * This is a simple or null object
257 status = acpi_ut_copy_isimple_to_esimple(source_object,
261 if (ACPI_FAILURE(status)) {
266 case ACPI_COPY_TYPE_PACKAGE:
269 * Build the package object
271 target_object->type = ACPI_TYPE_PACKAGE;
272 target_object->package.count = source_object->package.count;
273 target_object->package.elements =
274 ACPI_CAST_PTR(union acpi_object, info->free_space);
277 * Pass the new package object back to the package walk routine
279 state->pkg.this_target_obj = target_object;
282 * Save space for the array of objects (Package elements)
283 * update the buffer length counter
285 object_space = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
293 return (AE_BAD_PARAMETER);
296 info->free_space += object_space;
297 info->length += object_space;
301 /*******************************************************************************
303 * FUNCTION: acpi_ut_copy_ipackage_to_epackage
305 * PARAMETERS: internal_object - Pointer to the object we are returning
306 * Buffer - Where the object is returned
307 * space_used - Where the object length is returned
311 * DESCRIPTION: This function is called to place a package object in a user
312 * buffer. A package object by definition contains other objects.
314 * The buffer is assumed to have sufficient space for the object.
315 * The caller must have verified the buffer length needed using the
316 * acpi_ut_get_object_size function before calling this function.
318 ******************************************************************************/
321 acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
322 u8 * buffer, acpi_size * space_used)
324 union acpi_object *external_object;
326 struct acpi_pkg_info info;
328 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_epackage);
331 * First package at head of the buffer
333 external_object = ACPI_CAST_PTR(union acpi_object, buffer);
336 * Free space begins right after the first package
338 info.length = ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
340 buffer + ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
341 info.object_space = 0;
342 info.num_packages = 1;
344 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
345 external_object->package.count = internal_object->package.count;
346 external_object->package.elements = ACPI_CAST_PTR(union acpi_object,
350 * Leave room for an array of ACPI_OBJECTS in the buffer
351 * and move the free space past it
353 info.length += (acpi_size) external_object->package.count *
354 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
355 info.free_space += external_object->package.count *
356 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
358 status = acpi_ut_walk_package_tree(internal_object, external_object,
359 acpi_ut_copy_ielement_to_eelement,
362 *space_used = info.length;
363 return_ACPI_STATUS(status);
366 /*******************************************************************************
368 * FUNCTION: acpi_ut_copy_iobject_to_eobject
370 * PARAMETERS: internal_object - The internal object to be converted
371 * buffer_ptr - Where the object is returned
375 * DESCRIPTION: This function is called to build an API object to be returned to
378 ******************************************************************************/
381 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *internal_object,
382 struct acpi_buffer *ret_buffer)
386 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_eobject);
388 if (ACPI_GET_OBJECT_TYPE(internal_object) == ACPI_TYPE_PACKAGE) {
390 * Package object: Copy all subobjects (including
393 status = acpi_ut_copy_ipackage_to_epackage(internal_object,
395 &ret_buffer->length);
398 * Build a simple object (no nested objects)
400 status = acpi_ut_copy_isimple_to_esimple(internal_object,
408 ACPI_ROUND_UP_TO_NATIVE_WORD
412 &ret_buffer->length);
414 * build simple does not include the object size in the length
415 * so we add it in here
417 ret_buffer->length += sizeof(union acpi_object);
420 return_ACPI_STATUS(status);
423 /*******************************************************************************
425 * FUNCTION: acpi_ut_copy_esimple_to_isimple
427 * PARAMETERS: external_object - The external object to be converted
428 * ret_internal_object - Where the internal object is returned
432 * DESCRIPTION: This function copies an external object to an internal one.
433 * NOTE: Pointers can be copied, we don't need to copy data.
434 * (The pointers have to be valid in our address space no matter
435 * what we do with them!)
437 ******************************************************************************/
440 acpi_ut_copy_esimple_to_isimple(union acpi_object *external_object,
441 union acpi_operand_object **ret_internal_object)
443 union acpi_operand_object *internal_object;
445 ACPI_FUNCTION_TRACE(ut_copy_esimple_to_isimple);
448 * Simple types supported are: String, Buffer, Integer
450 switch (external_object->type) {
451 case ACPI_TYPE_STRING:
452 case ACPI_TYPE_BUFFER:
453 case ACPI_TYPE_INTEGER:
455 internal_object = acpi_ut_create_internal_object((u8)
458 if (!internal_object) {
459 return_ACPI_STATUS(AE_NO_MEMORY);
464 /* All other types are not supported */
466 return_ACPI_STATUS(AE_SUPPORT);
469 /* Must COPY string and buffer contents */
471 switch (external_object->type) {
472 case ACPI_TYPE_STRING:
474 internal_object->string.pointer =
475 ACPI_ALLOCATE_ZEROED((acpi_size) external_object->string.
477 if (!internal_object->string.pointer) {
481 ACPI_MEMCPY(internal_object->string.pointer,
482 external_object->string.pointer,
483 external_object->string.length);
485 internal_object->string.length = external_object->string.length;
488 case ACPI_TYPE_BUFFER:
490 internal_object->buffer.pointer =
491 ACPI_ALLOCATE_ZEROED(external_object->buffer.length);
492 if (!internal_object->buffer.pointer) {
496 ACPI_MEMCPY(internal_object->buffer.pointer,
497 external_object->buffer.pointer,
498 external_object->buffer.length);
500 internal_object->buffer.length = external_object->buffer.length;
503 case ACPI_TYPE_INTEGER:
505 internal_object->integer.value = external_object->integer.value;
509 /* Other types can't get here */
513 *ret_internal_object = internal_object;
514 return_ACPI_STATUS(AE_OK);
517 acpi_ut_remove_reference(internal_object);
518 return_ACPI_STATUS(AE_NO_MEMORY);
521 #ifdef ACPI_FUTURE_IMPLEMENTATION
522 /* Code to convert packages that are parameters to control methods */
524 /*******************************************************************************
526 * FUNCTION: acpi_ut_copy_epackage_to_ipackage
528 * PARAMETERS: *internal_object - Pointer to the object we are returning
529 * *Buffer - Where the object is returned
530 * *space_used - Where the length of the object is returned
534 * DESCRIPTION: This function is called to place a package object in a user
535 * buffer. A package object by definition contains other objects.
537 * The buffer is assumed to have sufficient space for the object.
538 * The caller must have verified the buffer length needed using the
539 * acpi_ut_get_object_size function before calling this function.
541 ******************************************************************************/
544 acpi_ut_copy_epackage_to_ipackage(union acpi_operand_object *internal_object,
545 u8 * buffer, u32 * space_used)
548 union acpi_object *external_object;
551 u32 object_space = 0;
552 union acpi_operand_object *this_internal_obj;
553 union acpi_object *this_external_obj;
555 ACPI_FUNCTION_TRACE(ut_copy_epackage_to_ipackage);
558 * First package at head of the buffer
560 external_object = (union acpi_object *)buffer;
563 * Free space begins right after the first package
565 free_space = buffer + sizeof(union acpi_object);
567 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
568 external_object->package.count = internal_object->package.count;
569 external_object->package.elements = (union acpi_object *)free_space;
572 * Build an array of ACPI_OBJECTS in the buffer
573 * and move the free space past it
576 external_object->package.count * sizeof(union acpi_object);
578 /* Call walk_package */
582 #endif /* Future implementation */
584 /*******************************************************************************
586 * FUNCTION: acpi_ut_copy_eobject_to_iobject
588 * PARAMETERS: *internal_object - The external object to be converted
589 * *buffer_ptr - Where the internal object is returned
591 * RETURN: Status - the status of the call
593 * DESCRIPTION: Converts an external object to an internal object.
595 ******************************************************************************/
598 acpi_ut_copy_eobject_to_iobject(union acpi_object *external_object,
599 union acpi_operand_object **internal_object)
603 ACPI_FUNCTION_TRACE(ut_copy_eobject_to_iobject);
605 if (external_object->type == ACPI_TYPE_PACKAGE) {
607 * Packages as external input to control methods are not supported,
610 "Packages as parameters not implemented!"));
612 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
617 * Build a simple object (no nested objects)
620 acpi_ut_copy_esimple_to_isimple(external_object,
624 return_ACPI_STATUS(status);
627 /*******************************************************************************
629 * FUNCTION: acpi_ut_copy_simple_object
631 * PARAMETERS: source_desc - The internal object to be copied
632 * dest_desc - New target object
636 * DESCRIPTION: Simple copy of one internal object to another. Reference count
637 * of the destination object is preserved.
639 ******************************************************************************/
642 acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
643 union acpi_operand_object *dest_desc)
646 union acpi_operand_object *next_object;
648 /* Save fields from destination that we don't want to overwrite */
650 reference_count = dest_desc->common.reference_count;
651 next_object = dest_desc->common.next_object;
653 /* Copy the entire source object over the destination object */
655 ACPI_MEMCPY((char *)dest_desc, (char *)source_desc,
656 sizeof(union acpi_operand_object));
658 /* Restore the saved fields */
660 dest_desc->common.reference_count = reference_count;
661 dest_desc->common.next_object = next_object;
663 /* New object is not static, regardless of source */
665 dest_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
667 /* Handle the objects with extra data */
669 switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
670 case ACPI_TYPE_BUFFER:
672 * Allocate and copy the actual buffer if and only if:
673 * 1) There is a valid buffer pointer
674 * 2) The buffer has a length > 0
676 if ((source_desc->buffer.pointer) &&
677 (source_desc->buffer.length)) {
678 dest_desc->buffer.pointer =
679 ACPI_ALLOCATE(source_desc->buffer.length);
680 if (!dest_desc->buffer.pointer) {
681 return (AE_NO_MEMORY);
684 /* Copy the actual buffer data */
686 ACPI_MEMCPY(dest_desc->buffer.pointer,
687 source_desc->buffer.pointer,
688 source_desc->buffer.length);
692 case ACPI_TYPE_STRING:
694 * Allocate and copy the actual string if and only if:
695 * 1) There is a valid string pointer
696 * (Pointer to a NULL string is allowed)
698 if (source_desc->string.pointer) {
699 dest_desc->string.pointer =
700 ACPI_ALLOCATE((acpi_size) source_desc->string.
702 if (!dest_desc->string.pointer) {
703 return (AE_NO_MEMORY);
706 /* Copy the actual string data */
708 ACPI_MEMCPY(dest_desc->string.pointer,
709 source_desc->string.pointer,
710 (acpi_size) source_desc->string.length + 1);
714 case ACPI_TYPE_LOCAL_REFERENCE:
716 * We copied the reference object, so we now must add a reference
717 * to the object pointed to by the reference
719 acpi_ut_add_reference(source_desc->reference.object);
722 case ACPI_TYPE_REGION:
724 * We copied the Region Handler, so we now must add a reference
726 if (dest_desc->region.handler) {
727 acpi_ut_add_reference(dest_desc->region.handler);
732 /* Nothing to do for other simple objects */
739 /*******************************************************************************
741 * FUNCTION: acpi_ut_copy_ielement_to_ielement
743 * PARAMETERS: acpi_pkg_callback
747 * DESCRIPTION: Copy one package element to another package element
749 ******************************************************************************/
752 acpi_ut_copy_ielement_to_ielement(u8 object_type,
753 union acpi_operand_object *source_object,
754 union acpi_generic_state *state,
757 acpi_status status = AE_OK;
759 union acpi_operand_object **this_target_ptr;
760 union acpi_operand_object *target_object;
762 ACPI_FUNCTION_ENTRY();
764 this_index = state->pkg.index;
765 this_target_ptr = (union acpi_operand_object **)
766 &state->pkg.dest_object->package.elements[this_index];
768 switch (object_type) {
769 case ACPI_COPY_TYPE_SIMPLE:
771 /* A null source object indicates a (legal) null package element */
775 * This is a simple object, just copy it
778 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE
780 if (!target_object) {
781 return (AE_NO_MEMORY);
785 acpi_ut_copy_simple_object(source_object,
787 if (ACPI_FAILURE(status)) {
791 *this_target_ptr = target_object;
793 /* Pass through a null element */
795 *this_target_ptr = NULL;
799 case ACPI_COPY_TYPE_PACKAGE:
802 * This object is a package - go down another nesting level
803 * Create and build the package object
806 acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
807 if (!target_object) {
808 return (AE_NO_MEMORY);
811 target_object->package.count = source_object->package.count;
812 target_object->common.flags = source_object->common.flags;
815 * Create the object array
817 target_object->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size) source_object->package.count + 1) * sizeof(void *));
818 if (!target_object->package.elements) {
819 status = AE_NO_MEMORY;
824 * Pass the new package object back to the package walk routine
826 state->pkg.this_target_obj = target_object;
829 * Store the object pointer in the parent package object
831 *this_target_ptr = target_object;
835 return (AE_BAD_PARAMETER);
841 acpi_ut_remove_reference(target_object);
845 /*******************************************************************************
847 * FUNCTION: acpi_ut_copy_ipackage_to_ipackage
849 * PARAMETERS: *source_obj - Pointer to the source package object
850 * *dest_obj - Where the internal object is returned
852 * RETURN: Status - the status of the call
854 * DESCRIPTION: This function is called to copy an internal package object
855 * into another internal package object.
857 ******************************************************************************/
860 acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
861 union acpi_operand_object *dest_obj,
862 struct acpi_walk_state *walk_state)
864 acpi_status status = AE_OK;
866 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_ipackage);
868 dest_obj->common.type = ACPI_GET_OBJECT_TYPE(source_obj);
869 dest_obj->common.flags = source_obj->common.flags;
870 dest_obj->package.count = source_obj->package.count;
873 * Create the object array and walk the source package tree
875 dest_obj->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
878 1) * sizeof(void *));
879 if (!dest_obj->package.elements) {
880 ACPI_ERROR((AE_INFO, "Package allocation failure"));
881 return_ACPI_STATUS(AE_NO_MEMORY);
885 * Copy the package element-by-element by walking the package "tree".
886 * This handles nested packages of arbitrary depth.
888 status = acpi_ut_walk_package_tree(source_obj, dest_obj,
889 acpi_ut_copy_ielement_to_ielement,
891 if (ACPI_FAILURE(status)) {
893 /* On failure, delete the destination package object */
895 acpi_ut_remove_reference(dest_obj);
898 return_ACPI_STATUS(status);
901 /*******************************************************************************
903 * FUNCTION: acpi_ut_copy_iobject_to_iobject
905 * PARAMETERS: walk_state - Current walk state
906 * source_desc - The internal object to be copied
907 * dest_desc - Where the copied object is returned
911 * DESCRIPTION: Copy an internal object to a new internal object
913 ******************************************************************************/
916 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
917 union acpi_operand_object **dest_desc,
918 struct acpi_walk_state *walk_state)
920 acpi_status status = AE_OK;
922 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_iobject);
924 /* Create the top level object */
927 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE(source_desc));
929 return_ACPI_STATUS(AE_NO_MEMORY);
932 /* Copy the object and possible subobjects */
934 if (ACPI_GET_OBJECT_TYPE(source_desc) == ACPI_TYPE_PACKAGE) {
936 acpi_ut_copy_ipackage_to_ipackage(source_desc, *dest_desc,
939 status = acpi_ut_copy_simple_object(source_desc, *dest_desc);
942 return_ACPI_STATUS(status);