Loading...
1/******************************************************************************
2 *
3 * Module Name: utcopy - Internal to external object translation utilities
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "acnamesp.h"
47
48
49#define _COMPONENT ACPI_UTILITIES
50ACPI_MODULE_NAME("utcopy")
51
52/* Local prototypes */
53static acpi_status
54acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
55 union acpi_object *external_object,
56 u8 * data_space, acpi_size * buffer_space_used);
57
58static acpi_status
59acpi_ut_copy_ielement_to_ielement(u8 object_type,
60 union acpi_operand_object *source_object,
61 union acpi_generic_state *state,
62 void *context);
63
64static acpi_status
65acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
66 u8 * buffer, acpi_size * space_used);
67
68static acpi_status
69acpi_ut_copy_esimple_to_isimple(union acpi_object *user_obj,
70 union acpi_operand_object **return_obj);
71
72static acpi_status
73acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
74 union acpi_operand_object **internal_object);
75
76static acpi_status
77acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
78 union acpi_operand_object *dest_desc);
79
80static acpi_status
81acpi_ut_copy_ielement_to_eelement(u8 object_type,
82 union acpi_operand_object *source_object,
83 union acpi_generic_state *state,
84 void *context);
85
86static acpi_status
87acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
88 union acpi_operand_object *dest_obj,
89 struct acpi_walk_state *walk_state);
90
91/*******************************************************************************
92 *
93 * FUNCTION: acpi_ut_copy_isimple_to_esimple
94 *
95 * PARAMETERS: internal_object - Source object to be copied
96 * external_object - Where to return the copied object
97 * data_space - Where object data is returned (such as
98 * buffer and string data)
99 * buffer_space_used - Length of data_space that was used
100 *
101 * RETURN: Status
102 *
103 * DESCRIPTION: This function is called to copy a simple internal object to
104 * an external object.
105 *
106 * The data_space buffer is assumed to have sufficient space for
107 * the object.
108 *
109 ******************************************************************************/
110
111static acpi_status
112acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
113 union acpi_object *external_object,
114 u8 * data_space, acpi_size * buffer_space_used)
115{
116 acpi_status status = AE_OK;
117
118 ACPI_FUNCTION_TRACE(ut_copy_isimple_to_esimple);
119
120 *buffer_space_used = 0;
121
122 /*
123 * Check for NULL object case (could be an uninitialized
124 * package element)
125 */
126 if (!internal_object) {
127 return_ACPI_STATUS(AE_OK);
128 }
129
130 /* Always clear the external object */
131
132 ACPI_MEMSET(external_object, 0, sizeof(union acpi_object));
133
134 /*
135 * In general, the external object will be the same type as
136 * the internal object
137 */
138 external_object->type = internal_object->common.type;
139
140 /* However, only a limited number of external types are supported */
141
142 switch (internal_object->common.type) {
143 case ACPI_TYPE_STRING:
144
145 external_object->string.pointer = (char *)data_space;
146 external_object->string.length = internal_object->string.length;
147 *buffer_space_used = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
148 internal_object->
149 string.
150 length + 1);
151
152 ACPI_MEMCPY((void *)data_space,
153 (void *)internal_object->string.pointer,
154 (acpi_size) internal_object->string.length + 1);
155 break;
156
157 case ACPI_TYPE_BUFFER:
158
159 external_object->buffer.pointer = data_space;
160 external_object->buffer.length = internal_object->buffer.length;
161 *buffer_space_used =
162 ACPI_ROUND_UP_TO_NATIVE_WORD(internal_object->string.
163 length);
164
165 ACPI_MEMCPY((void *)data_space,
166 (void *)internal_object->buffer.pointer,
167 internal_object->buffer.length);
168 break;
169
170 case ACPI_TYPE_INTEGER:
171
172 external_object->integer.value = internal_object->integer.value;
173 break;
174
175 case ACPI_TYPE_LOCAL_REFERENCE:
176
177 /* This is an object reference. */
178
179 switch (internal_object->reference.class) {
180 case ACPI_REFCLASS_NAME:
181
182 /*
183 * For namepath, return the object handle ("reference")
184 * We are referring to the namespace node
185 */
186 external_object->reference.handle =
187 internal_object->reference.node;
188 external_object->reference.actual_type =
189 acpi_ns_get_type(internal_object->reference.node);
190 break;
191
192 default:
193
194 /* All other reference types are unsupported */
195
196 return_ACPI_STATUS(AE_TYPE);
197 }
198 break;
199
200 case ACPI_TYPE_PROCESSOR:
201
202 external_object->processor.proc_id =
203 internal_object->processor.proc_id;
204 external_object->processor.pblk_address =
205 internal_object->processor.address;
206 external_object->processor.pblk_length =
207 internal_object->processor.length;
208 break;
209
210 case ACPI_TYPE_POWER:
211
212 external_object->power_resource.system_level =
213 internal_object->power_resource.system_level;
214
215 external_object->power_resource.resource_order =
216 internal_object->power_resource.resource_order;
217 break;
218
219 default:
220 /*
221 * There is no corresponding external object type
222 */
223 ACPI_ERROR((AE_INFO,
224 "Unsupported object type, cannot convert to external object: %s",
225 acpi_ut_get_type_name(internal_object->common.
226 type)));
227
228 return_ACPI_STATUS(AE_SUPPORT);
229 }
230
231 return_ACPI_STATUS(status);
232}
233
234/*******************************************************************************
235 *
236 * FUNCTION: acpi_ut_copy_ielement_to_eelement
237 *
238 * PARAMETERS: acpi_pkg_callback
239 *
240 * RETURN: Status
241 *
242 * DESCRIPTION: Copy one package element to another package element
243 *
244 ******************************************************************************/
245
246static acpi_status
247acpi_ut_copy_ielement_to_eelement(u8 object_type,
248 union acpi_operand_object *source_object,
249 union acpi_generic_state *state,
250 void *context)
251{
252 acpi_status status = AE_OK;
253 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
254 acpi_size object_space;
255 u32 this_index;
256 union acpi_object *target_object;
257
258 ACPI_FUNCTION_ENTRY();
259
260 this_index = state->pkg.index;
261 target_object = (union acpi_object *)
262 &((union acpi_object *)(state->pkg.dest_object))->package.
263 elements[this_index];
264
265 switch (object_type) {
266 case ACPI_COPY_TYPE_SIMPLE:
267
268 /*
269 * This is a simple or null object
270 */
271 status = acpi_ut_copy_isimple_to_esimple(source_object,
272 target_object,
273 info->free_space,
274 &object_space);
275 if (ACPI_FAILURE(status)) {
276 return (status);
277 }
278 break;
279
280 case ACPI_COPY_TYPE_PACKAGE:
281
282 /*
283 * Build the package object
284 */
285 target_object->type = ACPI_TYPE_PACKAGE;
286 target_object->package.count = source_object->package.count;
287 target_object->package.elements =
288 ACPI_CAST_PTR(union acpi_object, info->free_space);
289
290 /*
291 * Pass the new package object back to the package walk routine
292 */
293 state->pkg.this_target_obj = target_object;
294
295 /*
296 * Save space for the array of objects (Package elements)
297 * update the buffer length counter
298 */
299 object_space = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
300 target_object->
301 package.count *
302 sizeof(union
303 acpi_object));
304 break;
305
306 default:
307 return (AE_BAD_PARAMETER);
308 }
309
310 info->free_space += object_space;
311 info->length += object_space;
312 return (status);
313}
314
315/*******************************************************************************
316 *
317 * FUNCTION: acpi_ut_copy_ipackage_to_epackage
318 *
319 * PARAMETERS: internal_object - Pointer to the object we are returning
320 * Buffer - Where the object is returned
321 * space_used - Where the object length is returned
322 *
323 * RETURN: Status
324 *
325 * DESCRIPTION: This function is called to place a package object in a user
326 * buffer. A package object by definition contains other objects.
327 *
328 * The buffer is assumed to have sufficient space for the object.
329 * The caller must have verified the buffer length needed using
330 * the acpi_ut_get_object_size function before calling this function.
331 *
332 ******************************************************************************/
333
334static acpi_status
335acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
336 u8 * buffer, acpi_size * space_used)
337{
338 union acpi_object *external_object;
339 acpi_status status;
340 struct acpi_pkg_info info;
341
342 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_epackage);
343
344 /*
345 * First package at head of the buffer
346 */
347 external_object = ACPI_CAST_PTR(union acpi_object, buffer);
348
349 /*
350 * Free space begins right after the first package
351 */
352 info.length = ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
353 info.free_space =
354 buffer + ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
355 info.object_space = 0;
356 info.num_packages = 1;
357
358 external_object->type = internal_object->common.type;
359 external_object->package.count = internal_object->package.count;
360 external_object->package.elements = ACPI_CAST_PTR(union acpi_object,
361 info.free_space);
362
363 /*
364 * Leave room for an array of ACPI_OBJECTS in the buffer
365 * and move the free space past it
366 */
367 info.length += (acpi_size) external_object->package.count *
368 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
369 info.free_space += external_object->package.count *
370 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
371
372 status = acpi_ut_walk_package_tree(internal_object, external_object,
373 acpi_ut_copy_ielement_to_eelement,
374 &info);
375
376 *space_used = info.length;
377 return_ACPI_STATUS(status);
378}
379
380/*******************************************************************************
381 *
382 * FUNCTION: acpi_ut_copy_iobject_to_eobject
383 *
384 * PARAMETERS: internal_object - The internal object to be converted
385 * ret_buffer - Where the object is returned
386 *
387 * RETURN: Status
388 *
389 * DESCRIPTION: This function is called to build an API object to be returned
390 * to the caller.
391 *
392 ******************************************************************************/
393
394acpi_status
395acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *internal_object,
396 struct acpi_buffer *ret_buffer)
397{
398 acpi_status status;
399
400 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_eobject);
401
402 if (internal_object->common.type == ACPI_TYPE_PACKAGE) {
403 /*
404 * Package object: Copy all subobjects (including
405 * nested packages)
406 */
407 status = acpi_ut_copy_ipackage_to_epackage(internal_object,
408 ret_buffer->pointer,
409 &ret_buffer->length);
410 } else {
411 /*
412 * Build a simple object (no nested objects)
413 */
414 status = acpi_ut_copy_isimple_to_esimple(internal_object,
415 ACPI_CAST_PTR(union
416 acpi_object,
417 ret_buffer->
418 pointer),
419 ACPI_ADD_PTR(u8,
420 ret_buffer->
421 pointer,
422 ACPI_ROUND_UP_TO_NATIVE_WORD
423 (sizeof
424 (union
425 acpi_object))),
426 &ret_buffer->length);
427 /*
428 * build simple does not include the object size in the length
429 * so we add it in here
430 */
431 ret_buffer->length += sizeof(union acpi_object);
432 }
433
434 return_ACPI_STATUS(status);
435}
436
437/*******************************************************************************
438 *
439 * FUNCTION: acpi_ut_copy_esimple_to_isimple
440 *
441 * PARAMETERS: external_object - The external object to be converted
442 * ret_internal_object - Where the internal object is returned
443 *
444 * RETURN: Status
445 *
446 * DESCRIPTION: This function copies an external object to an internal one.
447 * NOTE: Pointers can be copied, we don't need to copy data.
448 * (The pointers have to be valid in our address space no matter
449 * what we do with them!)
450 *
451 ******************************************************************************/
452
453static acpi_status
454acpi_ut_copy_esimple_to_isimple(union acpi_object *external_object,
455 union acpi_operand_object **ret_internal_object)
456{
457 union acpi_operand_object *internal_object;
458
459 ACPI_FUNCTION_TRACE(ut_copy_esimple_to_isimple);
460
461 /*
462 * Simple types supported are: String, Buffer, Integer
463 */
464 switch (external_object->type) {
465 case ACPI_TYPE_STRING:
466 case ACPI_TYPE_BUFFER:
467 case ACPI_TYPE_INTEGER:
468 case ACPI_TYPE_LOCAL_REFERENCE:
469
470 internal_object = acpi_ut_create_internal_object((u8)
471 external_object->
472 type);
473 if (!internal_object) {
474 return_ACPI_STATUS(AE_NO_MEMORY);
475 }
476 break;
477
478 case ACPI_TYPE_ANY: /* This is the case for a NULL object */
479
480 *ret_internal_object = NULL;
481 return_ACPI_STATUS(AE_OK);
482
483 default:
484 /* All other types are not supported */
485
486 ACPI_ERROR((AE_INFO,
487 "Unsupported object type, cannot convert to internal object: %s",
488 acpi_ut_get_type_name(external_object->type)));
489
490 return_ACPI_STATUS(AE_SUPPORT);
491 }
492
493 /* Must COPY string and buffer contents */
494
495 switch (external_object->type) {
496 case ACPI_TYPE_STRING:
497
498 internal_object->string.pointer =
499 ACPI_ALLOCATE_ZEROED((acpi_size)
500 external_object->string.length + 1);
501
502 if (!internal_object->string.pointer) {
503 goto error_exit;
504 }
505
506 ACPI_MEMCPY(internal_object->string.pointer,
507 external_object->string.pointer,
508 external_object->string.length);
509
510 internal_object->string.length = external_object->string.length;
511 break;
512
513 case ACPI_TYPE_BUFFER:
514
515 internal_object->buffer.pointer =
516 ACPI_ALLOCATE_ZEROED(external_object->buffer.length);
517 if (!internal_object->buffer.pointer) {
518 goto error_exit;
519 }
520
521 ACPI_MEMCPY(internal_object->buffer.pointer,
522 external_object->buffer.pointer,
523 external_object->buffer.length);
524
525 internal_object->buffer.length = external_object->buffer.length;
526
527 /* Mark buffer data valid */
528
529 internal_object->buffer.flags |= AOPOBJ_DATA_VALID;
530 break;
531
532 case ACPI_TYPE_INTEGER:
533
534 internal_object->integer.value = external_object->integer.value;
535 break;
536
537 case ACPI_TYPE_LOCAL_REFERENCE:
538
539 /* TBD: should validate incoming handle */
540
541 internal_object->reference.class = ACPI_REFCLASS_NAME;
542 internal_object->reference.node =
543 external_object->reference.handle;
544 break;
545
546 default:
547 /* Other types can't get here */
548 break;
549 }
550
551 *ret_internal_object = internal_object;
552 return_ACPI_STATUS(AE_OK);
553
554 error_exit:
555 acpi_ut_remove_reference(internal_object);
556 return_ACPI_STATUS(AE_NO_MEMORY);
557}
558
559/*******************************************************************************
560 *
561 * FUNCTION: acpi_ut_copy_epackage_to_ipackage
562 *
563 * PARAMETERS: external_object - The external object to be converted
564 * internal_object - Where the internal object is returned
565 *
566 * RETURN: Status
567 *
568 * DESCRIPTION: Copy an external package object to an internal package.
569 * Handles nested packages.
570 *
571 ******************************************************************************/
572
573static acpi_status
574acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
575 union acpi_operand_object **internal_object)
576{
577 acpi_status status = AE_OK;
578 union acpi_operand_object *package_object;
579 union acpi_operand_object **package_elements;
580 u32 i;
581
582 ACPI_FUNCTION_TRACE(ut_copy_epackage_to_ipackage);
583
584 /* Create the package object */
585
586 package_object =
587 acpi_ut_create_package_object(external_object->package.count);
588 if (!package_object) {
589 return_ACPI_STATUS(AE_NO_MEMORY);
590 }
591
592 package_elements = package_object->package.elements;
593
594 /*
595 * Recursive implementation. Probably ok, since nested external packages
596 * as parameters should be very rare.
597 */
598 for (i = 0; i < external_object->package.count; i++) {
599 status =
600 acpi_ut_copy_eobject_to_iobject(&external_object->package.
601 elements[i],
602 &package_elements[i]);
603 if (ACPI_FAILURE(status)) {
604
605 /* Truncate package and delete it */
606
607 package_object->package.count = i;
608 package_elements[i] = NULL;
609 acpi_ut_remove_reference(package_object);
610 return_ACPI_STATUS(status);
611 }
612 }
613
614 /* Mark package data valid */
615
616 package_object->package.flags |= AOPOBJ_DATA_VALID;
617
618 *internal_object = package_object;
619 return_ACPI_STATUS(status);
620}
621
622/*******************************************************************************
623 *
624 * FUNCTION: acpi_ut_copy_eobject_to_iobject
625 *
626 * PARAMETERS: external_object - The external object to be converted
627 * internal_object - Where the internal object is returned
628 *
629 * RETURN: Status
630 *
631 * DESCRIPTION: Converts an external object to an internal object.
632 *
633 ******************************************************************************/
634
635acpi_status
636acpi_ut_copy_eobject_to_iobject(union acpi_object *external_object,
637 union acpi_operand_object **internal_object)
638{
639 acpi_status status;
640
641 ACPI_FUNCTION_TRACE(ut_copy_eobject_to_iobject);
642
643 if (external_object->type == ACPI_TYPE_PACKAGE) {
644 status =
645 acpi_ut_copy_epackage_to_ipackage(external_object,
646 internal_object);
647 } else {
648 /*
649 * Build a simple object (no nested objects)
650 */
651 status =
652 acpi_ut_copy_esimple_to_isimple(external_object,
653 internal_object);
654 }
655
656 return_ACPI_STATUS(status);
657}
658
659/*******************************************************************************
660 *
661 * FUNCTION: acpi_ut_copy_simple_object
662 *
663 * PARAMETERS: source_desc - The internal object to be copied
664 * dest_desc - New target object
665 *
666 * RETURN: Status
667 *
668 * DESCRIPTION: Simple copy of one internal object to another. Reference count
669 * of the destination object is preserved.
670 *
671 ******************************************************************************/
672
673static acpi_status
674acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
675 union acpi_operand_object *dest_desc)
676{
677 u16 reference_count;
678 union acpi_operand_object *next_object;
679 acpi_status status;
680 acpi_size copy_size;
681
682 /* Save fields from destination that we don't want to overwrite */
683
684 reference_count = dest_desc->common.reference_count;
685 next_object = dest_desc->common.next_object;
686
687 /*
688 * Copy the entire source object over the destination object.
689 * Note: Source can be either an operand object or namespace node.
690 */
691 copy_size = sizeof(union acpi_operand_object);
692 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_NAMED) {
693 copy_size = sizeof(struct acpi_namespace_node);
694 }
695
696 ACPI_MEMCPY(ACPI_CAST_PTR(char, dest_desc),
697 ACPI_CAST_PTR(char, source_desc), copy_size);
698
699 /* Restore the saved fields */
700
701 dest_desc->common.reference_count = reference_count;
702 dest_desc->common.next_object = next_object;
703
704 /* New object is not static, regardless of source */
705
706 dest_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
707
708 /* Handle the objects with extra data */
709
710 switch (dest_desc->common.type) {
711 case ACPI_TYPE_BUFFER:
712 /*
713 * Allocate and copy the actual buffer if and only if:
714 * 1) There is a valid buffer pointer
715 * 2) The buffer has a length > 0
716 */
717 if ((source_desc->buffer.pointer) &&
718 (source_desc->buffer.length)) {
719 dest_desc->buffer.pointer =
720 ACPI_ALLOCATE(source_desc->buffer.length);
721 if (!dest_desc->buffer.pointer) {
722 return (AE_NO_MEMORY);
723 }
724
725 /* Copy the actual buffer data */
726
727 ACPI_MEMCPY(dest_desc->buffer.pointer,
728 source_desc->buffer.pointer,
729 source_desc->buffer.length);
730 }
731 break;
732
733 case ACPI_TYPE_STRING:
734 /*
735 * Allocate and copy the actual string if and only if:
736 * 1) There is a valid string pointer
737 * (Pointer to a NULL string is allowed)
738 */
739 if (source_desc->string.pointer) {
740 dest_desc->string.pointer =
741 ACPI_ALLOCATE((acpi_size) source_desc->string.
742 length + 1);
743 if (!dest_desc->string.pointer) {
744 return (AE_NO_MEMORY);
745 }
746
747 /* Copy the actual string data */
748
749 ACPI_MEMCPY(dest_desc->string.pointer,
750 source_desc->string.pointer,
751 (acpi_size) source_desc->string.length + 1);
752 }
753 break;
754
755 case ACPI_TYPE_LOCAL_REFERENCE:
756 /*
757 * We copied the reference object, so we now must add a reference
758 * to the object pointed to by the reference
759 *
760 * DDBHandle reference (from Load/load_table) is a special reference,
761 * it does not have a Reference.Object, so does not need to
762 * increase the reference count
763 */
764 if (source_desc->reference.class == ACPI_REFCLASS_TABLE) {
765 break;
766 }
767
768 acpi_ut_add_reference(source_desc->reference.object);
769 break;
770
771 case ACPI_TYPE_REGION:
772 /*
773 * We copied the Region Handler, so we now must add a reference
774 */
775 if (dest_desc->region.handler) {
776 acpi_ut_add_reference(dest_desc->region.handler);
777 }
778 break;
779
780 /*
781 * For Mutex and Event objects, we cannot simply copy the underlying
782 * OS object. We must create a new one.
783 */
784 case ACPI_TYPE_MUTEX:
785
786 status = acpi_os_create_mutex(&dest_desc->mutex.os_mutex);
787 if (ACPI_FAILURE(status)) {
788 return status;
789 }
790 break;
791
792 case ACPI_TYPE_EVENT:
793
794 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
795 &dest_desc->event.
796 os_semaphore);
797 if (ACPI_FAILURE(status)) {
798 return status;
799 }
800 break;
801
802 default:
803 /* Nothing to do for other simple objects */
804 break;
805 }
806
807 return (AE_OK);
808}
809
810/*******************************************************************************
811 *
812 * FUNCTION: acpi_ut_copy_ielement_to_ielement
813 *
814 * PARAMETERS: acpi_pkg_callback
815 *
816 * RETURN: Status
817 *
818 * DESCRIPTION: Copy one package element to another package element
819 *
820 ******************************************************************************/
821
822static acpi_status
823acpi_ut_copy_ielement_to_ielement(u8 object_type,
824 union acpi_operand_object *source_object,
825 union acpi_generic_state *state,
826 void *context)
827{
828 acpi_status status = AE_OK;
829 u32 this_index;
830 union acpi_operand_object **this_target_ptr;
831 union acpi_operand_object *target_object;
832
833 ACPI_FUNCTION_ENTRY();
834
835 this_index = state->pkg.index;
836 this_target_ptr = (union acpi_operand_object **)
837 &state->pkg.dest_object->package.elements[this_index];
838
839 switch (object_type) {
840 case ACPI_COPY_TYPE_SIMPLE:
841
842 /* A null source object indicates a (legal) null package element */
843
844 if (source_object) {
845 /*
846 * This is a simple object, just copy it
847 */
848 target_object =
849 acpi_ut_create_internal_object(source_object->
850 common.type);
851 if (!target_object) {
852 return (AE_NO_MEMORY);
853 }
854
855 status =
856 acpi_ut_copy_simple_object(source_object,
857 target_object);
858 if (ACPI_FAILURE(status)) {
859 goto error_exit;
860 }
861
862 *this_target_ptr = target_object;
863 } else {
864 /* Pass through a null element */
865
866 *this_target_ptr = NULL;
867 }
868 break;
869
870 case ACPI_COPY_TYPE_PACKAGE:
871
872 /*
873 * This object is a package - go down another nesting level
874 * Create and build the package object
875 */
876 target_object =
877 acpi_ut_create_package_object(source_object->package.count);
878 if (!target_object) {
879 return (AE_NO_MEMORY);
880 }
881
882 target_object->common.flags = source_object->common.flags;
883
884 /* Pass the new package object back to the package walk routine */
885
886 state->pkg.this_target_obj = target_object;
887
888 /* Store the object pointer in the parent package object */
889
890 *this_target_ptr = target_object;
891 break;
892
893 default:
894 return (AE_BAD_PARAMETER);
895 }
896
897 return (status);
898
899 error_exit:
900 acpi_ut_remove_reference(target_object);
901 return (status);
902}
903
904/*******************************************************************************
905 *
906 * FUNCTION: acpi_ut_copy_ipackage_to_ipackage
907 *
908 * PARAMETERS: source_obj - Pointer to the source package object
909 * dest_obj - Where the internal object is returned
910 * walk_state - Current Walk state descriptor
911 *
912 * RETURN: Status
913 *
914 * DESCRIPTION: This function is called to copy an internal package object
915 * into another internal package object.
916 *
917 ******************************************************************************/
918
919static acpi_status
920acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
921 union acpi_operand_object *dest_obj,
922 struct acpi_walk_state *walk_state)
923{
924 acpi_status status = AE_OK;
925
926 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_ipackage);
927
928 dest_obj->common.type = source_obj->common.type;
929 dest_obj->common.flags = source_obj->common.flags;
930 dest_obj->package.count = source_obj->package.count;
931
932 /*
933 * Create the object array and walk the source package tree
934 */
935 dest_obj->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
936 source_obj->package.
937 count +
938 1) * sizeof(void *));
939 if (!dest_obj->package.elements) {
940 ACPI_ERROR((AE_INFO, "Package allocation failure"));
941 return_ACPI_STATUS(AE_NO_MEMORY);
942 }
943
944 /*
945 * Copy the package element-by-element by walking the package "tree".
946 * This handles nested packages of arbitrary depth.
947 */
948 status = acpi_ut_walk_package_tree(source_obj, dest_obj,
949 acpi_ut_copy_ielement_to_ielement,
950 walk_state);
951 if (ACPI_FAILURE(status)) {
952
953 /* On failure, delete the destination package object */
954
955 acpi_ut_remove_reference(dest_obj);
956 }
957
958 return_ACPI_STATUS(status);
959}
960
961/*******************************************************************************
962 *
963 * FUNCTION: acpi_ut_copy_iobject_to_iobject
964 *
965 * PARAMETERS: source_desc - The internal object to be copied
966 * dest_desc - Where the copied object is returned
967 * walk_state - Current walk state
968 *
969 * RETURN: Status
970 *
971 * DESCRIPTION: Copy an internal object to a new internal object
972 *
973 ******************************************************************************/
974
975acpi_status
976acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
977 union acpi_operand_object **dest_desc,
978 struct acpi_walk_state *walk_state)
979{
980 acpi_status status = AE_OK;
981
982 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_iobject);
983
984 /* Create the top level object */
985
986 *dest_desc = acpi_ut_create_internal_object(source_desc->common.type);
987 if (!*dest_desc) {
988 return_ACPI_STATUS(AE_NO_MEMORY);
989 }
990
991 /* Copy the object and possible subobjects */
992
993 if (source_desc->common.type == ACPI_TYPE_PACKAGE) {
994 status =
995 acpi_ut_copy_ipackage_to_ipackage(source_desc, *dest_desc,
996 walk_state);
997 } else {
998 status = acpi_ut_copy_simple_object(source_desc, *dest_desc);
999 }
1000
1001 return_ACPI_STATUS(status);
1002}
1/******************************************************************************
2 *
3 * Module Name: utcopy - Internal to external object translation utilities
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "acnamesp.h"
47
48
49#define _COMPONENT ACPI_UTILITIES
50ACPI_MODULE_NAME("utcopy")
51
52/* Local prototypes */
53static acpi_status
54acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
55 union acpi_object *external_object,
56 u8 * data_space, acpi_size * buffer_space_used);
57
58static acpi_status
59acpi_ut_copy_ielement_to_ielement(u8 object_type,
60 union acpi_operand_object *source_object,
61 union acpi_generic_state *state,
62 void *context);
63
64static acpi_status
65acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
66 u8 * buffer, acpi_size * space_used);
67
68static acpi_status
69acpi_ut_copy_esimple_to_isimple(union acpi_object *user_obj,
70 union acpi_operand_object **return_obj);
71
72static acpi_status
73acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
74 union acpi_operand_object **internal_object);
75
76static acpi_status
77acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
78 union acpi_operand_object *dest_desc);
79
80static acpi_status
81acpi_ut_copy_ielement_to_eelement(u8 object_type,
82 union acpi_operand_object *source_object,
83 union acpi_generic_state *state,
84 void *context);
85
86static acpi_status
87acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
88 union acpi_operand_object *dest_obj,
89 struct acpi_walk_state *walk_state);
90
91/*******************************************************************************
92 *
93 * FUNCTION: acpi_ut_copy_isimple_to_esimple
94 *
95 * PARAMETERS: internal_object - Source object to be copied
96 * external_object - Where to return the copied object
97 * data_space - Where object data is returned (such as
98 * buffer and string data)
99 * buffer_space_used - Length of data_space that was used
100 *
101 * RETURN: Status
102 *
103 * DESCRIPTION: This function is called to copy a simple internal object to
104 * an external object.
105 *
106 * The data_space buffer is assumed to have sufficient space for
107 * the object.
108 *
109 ******************************************************************************/
110
111static acpi_status
112acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
113 union acpi_object *external_object,
114 u8 * data_space, acpi_size * buffer_space_used)
115{
116 acpi_status status = AE_OK;
117
118 ACPI_FUNCTION_TRACE(ut_copy_isimple_to_esimple);
119
120 *buffer_space_used = 0;
121
122 /*
123 * Check for NULL object case (could be an uninitialized
124 * package element)
125 */
126 if (!internal_object) {
127 return_ACPI_STATUS(AE_OK);
128 }
129
130 /* Always clear the external object */
131
132 memset(external_object, 0, sizeof(union acpi_object));
133
134 /*
135 * In general, the external object will be the same type as
136 * the internal object
137 */
138 external_object->type = internal_object->common.type;
139
140 /* However, only a limited number of external types are supported */
141
142 switch (internal_object->common.type) {
143 case ACPI_TYPE_STRING:
144
145 external_object->string.pointer = (char *)data_space;
146 external_object->string.length = internal_object->string.length;
147 *buffer_space_used = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
148 internal_object->
149 string.
150 length + 1);
151
152 memcpy((void *)data_space,
153 (void *)internal_object->string.pointer,
154 (acpi_size) internal_object->string.length + 1);
155 break;
156
157 case ACPI_TYPE_BUFFER:
158
159 external_object->buffer.pointer = data_space;
160 external_object->buffer.length = internal_object->buffer.length;
161 *buffer_space_used =
162 ACPI_ROUND_UP_TO_NATIVE_WORD(internal_object->string.
163 length);
164
165 memcpy((void *)data_space,
166 (void *)internal_object->buffer.pointer,
167 internal_object->buffer.length);
168 break;
169
170 case ACPI_TYPE_INTEGER:
171
172 external_object->integer.value = internal_object->integer.value;
173 break;
174
175 case ACPI_TYPE_LOCAL_REFERENCE:
176
177 /* This is an object reference. */
178
179 switch (internal_object->reference.class) {
180 case ACPI_REFCLASS_NAME:
181 /*
182 * For namepath, return the object handle ("reference")
183 * We are referring to the namespace node
184 */
185 external_object->reference.handle =
186 internal_object->reference.node;
187 external_object->reference.actual_type =
188 acpi_ns_get_type(internal_object->reference.node);
189 break;
190
191 default:
192
193 /* All other reference types are unsupported */
194
195 return_ACPI_STATUS(AE_TYPE);
196 }
197 break;
198
199 case ACPI_TYPE_PROCESSOR:
200
201 external_object->processor.proc_id =
202 internal_object->processor.proc_id;
203 external_object->processor.pblk_address =
204 internal_object->processor.address;
205 external_object->processor.pblk_length =
206 internal_object->processor.length;
207 break;
208
209 case ACPI_TYPE_POWER:
210
211 external_object->power_resource.system_level =
212 internal_object->power_resource.system_level;
213
214 external_object->power_resource.resource_order =
215 internal_object->power_resource.resource_order;
216 break;
217
218 default:
219 /*
220 * There is no corresponding external object type
221 */
222 ACPI_ERROR((AE_INFO,
223 "Unsupported object type, cannot convert to external object: %s",
224 acpi_ut_get_type_name(internal_object->common.
225 type)));
226
227 return_ACPI_STATUS(AE_SUPPORT);
228 }
229
230 return_ACPI_STATUS(status);
231}
232
233/*******************************************************************************
234 *
235 * FUNCTION: acpi_ut_copy_ielement_to_eelement
236 *
237 * PARAMETERS: acpi_pkg_callback
238 *
239 * RETURN: Status
240 *
241 * DESCRIPTION: Copy one package element to another package element
242 *
243 ******************************************************************************/
244
245static acpi_status
246acpi_ut_copy_ielement_to_eelement(u8 object_type,
247 union acpi_operand_object *source_object,
248 union acpi_generic_state *state,
249 void *context)
250{
251 acpi_status status = AE_OK;
252 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
253 acpi_size object_space;
254 u32 this_index;
255 union acpi_object *target_object;
256
257 ACPI_FUNCTION_ENTRY();
258
259 this_index = state->pkg.index;
260 target_object = (union acpi_object *)&((union acpi_object *)
261 (state->pkg.dest_object))->
262 package.elements[this_index];
263
264 switch (object_type) {
265 case ACPI_COPY_TYPE_SIMPLE:
266 /*
267 * This is a simple or null object
268 */
269 status = acpi_ut_copy_isimple_to_esimple(source_object,
270 target_object,
271 info->free_space,
272 &object_space);
273 if (ACPI_FAILURE(status)) {
274 return (status);
275 }
276 break;
277
278 case ACPI_COPY_TYPE_PACKAGE:
279 /*
280 * Build the package object
281 */
282 target_object->type = ACPI_TYPE_PACKAGE;
283 target_object->package.count = source_object->package.count;
284 target_object->package.elements =
285 ACPI_CAST_PTR(union acpi_object, info->free_space);
286
287 /*
288 * Pass the new package object back to the package walk routine
289 */
290 state->pkg.this_target_obj = target_object;
291
292 /*
293 * Save space for the array of objects (Package elements)
294 * update the buffer length counter
295 */
296 object_space = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
297 target_object->
298 package.count *
299 sizeof(union
300 acpi_object));
301 break;
302
303 default:
304
305 return (AE_BAD_PARAMETER);
306 }
307
308 info->free_space += object_space;
309 info->length += object_space;
310 return (status);
311}
312
313/*******************************************************************************
314 *
315 * FUNCTION: acpi_ut_copy_ipackage_to_epackage
316 *
317 * PARAMETERS: internal_object - Pointer to the object we are returning
318 * buffer - Where the object is returned
319 * space_used - Where the object length is returned
320 *
321 * RETURN: Status
322 *
323 * DESCRIPTION: This function is called to place a package object in a user
324 * buffer. A package object by definition contains other objects.
325 *
326 * The buffer is assumed to have sufficient space for the object.
327 * The caller must have verified the buffer length needed using
328 * the acpi_ut_get_object_size function before calling this function.
329 *
330 ******************************************************************************/
331
332static acpi_status
333acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
334 u8 * buffer, acpi_size * space_used)
335{
336 union acpi_object *external_object;
337 acpi_status status;
338 struct acpi_pkg_info info;
339
340 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_epackage);
341
342 /*
343 * First package at head of the buffer
344 */
345 external_object = ACPI_CAST_PTR(union acpi_object, buffer);
346
347 /*
348 * Free space begins right after the first package
349 */
350 info.length = ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
351 info.free_space = buffer +
352 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
353 info.object_space = 0;
354 info.num_packages = 1;
355
356 external_object->type = internal_object->common.type;
357 external_object->package.count = internal_object->package.count;
358 external_object->package.elements =
359 ACPI_CAST_PTR(union acpi_object, info.free_space);
360
361 /*
362 * Leave room for an array of ACPI_OBJECTS in the buffer
363 * and move the free space past it
364 */
365 info.length += (acpi_size) external_object->package.count *
366 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
367 info.free_space += external_object->package.count *
368 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
369
370 status = acpi_ut_walk_package_tree(internal_object, external_object,
371 acpi_ut_copy_ielement_to_eelement,
372 &info);
373
374 *space_used = info.length;
375 return_ACPI_STATUS(status);
376}
377
378/*******************************************************************************
379 *
380 * FUNCTION: acpi_ut_copy_iobject_to_eobject
381 *
382 * PARAMETERS: internal_object - The internal object to be converted
383 * ret_buffer - Where the object is returned
384 *
385 * RETURN: Status
386 *
387 * DESCRIPTION: This function is called to build an API object to be returned
388 * to the caller.
389 *
390 ******************************************************************************/
391
392acpi_status
393acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *internal_object,
394 struct acpi_buffer *ret_buffer)
395{
396 acpi_status status;
397
398 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_eobject);
399
400 if (internal_object->common.type == ACPI_TYPE_PACKAGE) {
401 /*
402 * Package object: Copy all subobjects (including
403 * nested packages)
404 */
405 status = acpi_ut_copy_ipackage_to_epackage(internal_object,
406 ret_buffer->pointer,
407 &ret_buffer->length);
408 } else {
409 /*
410 * Build a simple object (no nested objects)
411 */
412 status = acpi_ut_copy_isimple_to_esimple(internal_object,
413 ACPI_CAST_PTR(union
414 acpi_object,
415 ret_buffer->
416 pointer),
417 ACPI_ADD_PTR(u8,
418 ret_buffer->
419 pointer,
420 ACPI_ROUND_UP_TO_NATIVE_WORD
421 (sizeof
422 (union
423 acpi_object))),
424 &ret_buffer->length);
425 /*
426 * build simple does not include the object size in the length
427 * so we add it in here
428 */
429 ret_buffer->length += sizeof(union acpi_object);
430 }
431
432 return_ACPI_STATUS(status);
433}
434
435/*******************************************************************************
436 *
437 * FUNCTION: acpi_ut_copy_esimple_to_isimple
438 *
439 * PARAMETERS: external_object - The external object to be converted
440 * ret_internal_object - Where the internal object is returned
441 *
442 * RETURN: Status
443 *
444 * DESCRIPTION: This function copies an external object to an internal one.
445 * NOTE: Pointers can be copied, we don't need to copy data.
446 * (The pointers have to be valid in our address space no matter
447 * what we do with them!)
448 *
449 ******************************************************************************/
450
451static acpi_status
452acpi_ut_copy_esimple_to_isimple(union acpi_object *external_object,
453 union acpi_operand_object **ret_internal_object)
454{
455 union acpi_operand_object *internal_object;
456
457 ACPI_FUNCTION_TRACE(ut_copy_esimple_to_isimple);
458
459 /*
460 * Simple types supported are: String, Buffer, Integer
461 */
462 switch (external_object->type) {
463 case ACPI_TYPE_STRING:
464 case ACPI_TYPE_BUFFER:
465 case ACPI_TYPE_INTEGER:
466 case ACPI_TYPE_LOCAL_REFERENCE:
467
468 internal_object = acpi_ut_create_internal_object((u8)
469 external_object->
470 type);
471 if (!internal_object) {
472 return_ACPI_STATUS(AE_NO_MEMORY);
473 }
474 break;
475
476 case ACPI_TYPE_ANY: /* This is the case for a NULL object */
477
478 *ret_internal_object = NULL;
479 return_ACPI_STATUS(AE_OK);
480
481 default:
482
483 /* All other types are not supported */
484
485 ACPI_ERROR((AE_INFO,
486 "Unsupported object type, cannot convert to internal object: %s",
487 acpi_ut_get_type_name(external_object->type)));
488
489 return_ACPI_STATUS(AE_SUPPORT);
490 }
491
492 /* Must COPY string and buffer contents */
493
494 switch (external_object->type) {
495 case ACPI_TYPE_STRING:
496
497 internal_object->string.pointer =
498 ACPI_ALLOCATE_ZEROED((acpi_size)
499 external_object->string.length + 1);
500
501 if (!internal_object->string.pointer) {
502 goto error_exit;
503 }
504
505 memcpy(internal_object->string.pointer,
506 external_object->string.pointer,
507 external_object->string.length);
508
509 internal_object->string.length = external_object->string.length;
510 break;
511
512 case ACPI_TYPE_BUFFER:
513
514 internal_object->buffer.pointer =
515 ACPI_ALLOCATE_ZEROED(external_object->buffer.length);
516 if (!internal_object->buffer.pointer) {
517 goto error_exit;
518 }
519
520 memcpy(internal_object->buffer.pointer,
521 external_object->buffer.pointer,
522 external_object->buffer.length);
523
524 internal_object->buffer.length = external_object->buffer.length;
525
526 /* Mark buffer data valid */
527
528 internal_object->buffer.flags |= AOPOBJ_DATA_VALID;
529 break;
530
531 case ACPI_TYPE_INTEGER:
532
533 internal_object->integer.value = external_object->integer.value;
534 break;
535
536 case ACPI_TYPE_LOCAL_REFERENCE:
537
538 /* An incoming reference is defined to be a namespace node */
539
540 internal_object->reference.class = ACPI_REFCLASS_REFOF;
541 internal_object->reference.object =
542 external_object->reference.handle;
543 break;
544
545 default:
546
547 /* Other types can't get here */
548
549 break;
550 }
551
552 *ret_internal_object = internal_object;
553 return_ACPI_STATUS(AE_OK);
554
555error_exit:
556 acpi_ut_remove_reference(internal_object);
557 return_ACPI_STATUS(AE_NO_MEMORY);
558}
559
560/*******************************************************************************
561 *
562 * FUNCTION: acpi_ut_copy_epackage_to_ipackage
563 *
564 * PARAMETERS: external_object - The external object to be converted
565 * internal_object - Where the internal object is returned
566 *
567 * RETURN: Status
568 *
569 * DESCRIPTION: Copy an external package object to an internal package.
570 * Handles nested packages.
571 *
572 ******************************************************************************/
573
574static acpi_status
575acpi_ut_copy_epackage_to_ipackage(union acpi_object *external_object,
576 union acpi_operand_object **internal_object)
577{
578 acpi_status status = AE_OK;
579 union acpi_operand_object *package_object;
580 union acpi_operand_object **package_elements;
581 u32 i;
582
583 ACPI_FUNCTION_TRACE(ut_copy_epackage_to_ipackage);
584
585 /* Create the package object */
586
587 package_object =
588 acpi_ut_create_package_object(external_object->package.count);
589 if (!package_object) {
590 return_ACPI_STATUS(AE_NO_MEMORY);
591 }
592
593 package_elements = package_object->package.elements;
594
595 /*
596 * Recursive implementation. Probably ok, since nested external
597 * packages as parameters should be very rare.
598 */
599 for (i = 0; i < external_object->package.count; i++) {
600 status =
601 acpi_ut_copy_eobject_to_iobject(&external_object->package.
602 elements[i],
603 &package_elements[i]);
604 if (ACPI_FAILURE(status)) {
605
606 /* Truncate package and delete it */
607
608 package_object->package.count = i;
609 package_elements[i] = NULL;
610 acpi_ut_remove_reference(package_object);
611 return_ACPI_STATUS(status);
612 }
613 }
614
615 /* Mark package data valid */
616
617 package_object->package.flags |= AOPOBJ_DATA_VALID;
618
619 *internal_object = package_object;
620 return_ACPI_STATUS(status);
621}
622
623/*******************************************************************************
624 *
625 * FUNCTION: acpi_ut_copy_eobject_to_iobject
626 *
627 * PARAMETERS: external_object - The external object to be converted
628 * internal_object - Where the internal object is returned
629 *
630 * RETURN: Status
631 *
632 * DESCRIPTION: Converts an external object to an internal object.
633 *
634 ******************************************************************************/
635
636acpi_status
637acpi_ut_copy_eobject_to_iobject(union acpi_object *external_object,
638 union acpi_operand_object **internal_object)
639{
640 acpi_status status;
641
642 ACPI_FUNCTION_TRACE(ut_copy_eobject_to_iobject);
643
644 if (external_object->type == ACPI_TYPE_PACKAGE) {
645 status =
646 acpi_ut_copy_epackage_to_ipackage(external_object,
647 internal_object);
648 } else {
649 /*
650 * Build a simple object (no nested objects)
651 */
652 status = acpi_ut_copy_esimple_to_isimple(external_object,
653 internal_object);
654 }
655
656 return_ACPI_STATUS(status);
657}
658
659/*******************************************************************************
660 *
661 * FUNCTION: acpi_ut_copy_simple_object
662 *
663 * PARAMETERS: source_desc - The internal object to be copied
664 * dest_desc - New target object
665 *
666 * RETURN: Status
667 *
668 * DESCRIPTION: Simple copy of one internal object to another. Reference count
669 * of the destination object is preserved.
670 *
671 ******************************************************************************/
672
673static acpi_status
674acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
675 union acpi_operand_object *dest_desc)
676{
677 u16 reference_count;
678 union acpi_operand_object *next_object;
679 acpi_status status;
680 acpi_size copy_size;
681
682 /* Save fields from destination that we don't want to overwrite */
683
684 reference_count = dest_desc->common.reference_count;
685 next_object = dest_desc->common.next_object;
686
687 /*
688 * Copy the entire source object over the destination object.
689 * Note: Source can be either an operand object or namespace node.
690 */
691 copy_size = sizeof(union acpi_operand_object);
692 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_NAMED) {
693 copy_size = sizeof(struct acpi_namespace_node);
694 }
695
696 memcpy(ACPI_CAST_PTR(char, dest_desc),
697 ACPI_CAST_PTR(char, source_desc), copy_size);
698
699 /* Restore the saved fields */
700
701 dest_desc->common.reference_count = reference_count;
702 dest_desc->common.next_object = next_object;
703
704 /* New object is not static, regardless of source */
705
706 dest_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
707
708 /* Handle the objects with extra data */
709
710 switch (dest_desc->common.type) {
711 case ACPI_TYPE_BUFFER:
712 /*
713 * Allocate and copy the actual buffer if and only if:
714 * 1) There is a valid buffer pointer
715 * 2) The buffer has a length > 0
716 */
717 if ((source_desc->buffer.pointer) &&
718 (source_desc->buffer.length)) {
719 dest_desc->buffer.pointer =
720 ACPI_ALLOCATE(source_desc->buffer.length);
721 if (!dest_desc->buffer.pointer) {
722 return (AE_NO_MEMORY);
723 }
724
725 /* Copy the actual buffer data */
726
727 memcpy(dest_desc->buffer.pointer,
728 source_desc->buffer.pointer,
729 source_desc->buffer.length);
730 }
731 break;
732
733 case ACPI_TYPE_STRING:
734 /*
735 * Allocate and copy the actual string if and only if:
736 * 1) There is a valid string pointer
737 * (Pointer to a NULL string is allowed)
738 */
739 if (source_desc->string.pointer) {
740 dest_desc->string.pointer =
741 ACPI_ALLOCATE((acpi_size) source_desc->string.
742 length + 1);
743 if (!dest_desc->string.pointer) {
744 return (AE_NO_MEMORY);
745 }
746
747 /* Copy the actual string data */
748
749 memcpy(dest_desc->string.pointer,
750 source_desc->string.pointer,
751 (acpi_size) source_desc->string.length + 1);
752 }
753 break;
754
755 case ACPI_TYPE_LOCAL_REFERENCE:
756 /*
757 * We copied the reference object, so we now must add a reference
758 * to the object pointed to by the reference
759 *
760 * DDBHandle reference (from Load/load_table) is a special reference,
761 * it does not have a Reference.Object, so does not need to
762 * increase the reference count
763 */
764 if (source_desc->reference.class == ACPI_REFCLASS_TABLE) {
765 break;
766 }
767
768 acpi_ut_add_reference(source_desc->reference.object);
769 break;
770
771 case ACPI_TYPE_REGION:
772 /*
773 * We copied the Region Handler, so we now must add a reference
774 */
775 if (dest_desc->region.handler) {
776 acpi_ut_add_reference(dest_desc->region.handler);
777 }
778 break;
779
780 /*
781 * For Mutex and Event objects, we cannot simply copy the underlying
782 * OS object. We must create a new one.
783 */
784 case ACPI_TYPE_MUTEX:
785
786 status = acpi_os_create_mutex(&dest_desc->mutex.os_mutex);
787 if (ACPI_FAILURE(status)) {
788 return (status);
789 }
790 break;
791
792 case ACPI_TYPE_EVENT:
793
794 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
795 &dest_desc->event.
796 os_semaphore);
797 if (ACPI_FAILURE(status)) {
798 return (status);
799 }
800 break;
801
802 default:
803
804 /* Nothing to do for other simple objects */
805
806 break;
807 }
808
809 return (AE_OK);
810}
811
812/*******************************************************************************
813 *
814 * FUNCTION: acpi_ut_copy_ielement_to_ielement
815 *
816 * PARAMETERS: acpi_pkg_callback
817 *
818 * RETURN: Status
819 *
820 * DESCRIPTION: Copy one package element to another package element
821 *
822 ******************************************************************************/
823
824static acpi_status
825acpi_ut_copy_ielement_to_ielement(u8 object_type,
826 union acpi_operand_object *source_object,
827 union acpi_generic_state *state,
828 void *context)
829{
830 acpi_status status = AE_OK;
831 u32 this_index;
832 union acpi_operand_object **this_target_ptr;
833 union acpi_operand_object *target_object;
834
835 ACPI_FUNCTION_ENTRY();
836
837 this_index = state->pkg.index;
838 this_target_ptr = (union acpi_operand_object **)
839 &state->pkg.dest_object->package.elements[this_index];
840
841 switch (object_type) {
842 case ACPI_COPY_TYPE_SIMPLE:
843
844 /* A null source object indicates a (legal) null package element */
845
846 if (source_object) {
847 /*
848 * This is a simple object, just copy it
849 */
850 target_object =
851 acpi_ut_create_internal_object(source_object->
852 common.type);
853 if (!target_object) {
854 return (AE_NO_MEMORY);
855 }
856
857 status =
858 acpi_ut_copy_simple_object(source_object,
859 target_object);
860 if (ACPI_FAILURE(status)) {
861 goto error_exit;
862 }
863
864 *this_target_ptr = target_object;
865 } else {
866 /* Pass through a null element */
867
868 *this_target_ptr = NULL;
869 }
870 break;
871
872 case ACPI_COPY_TYPE_PACKAGE:
873 /*
874 * This object is a package - go down another nesting level
875 * Create and build the package object
876 */
877 target_object =
878 acpi_ut_create_package_object(source_object->package.count);
879 if (!target_object) {
880 return (AE_NO_MEMORY);
881 }
882
883 target_object->common.flags = source_object->common.flags;
884
885 /* Pass the new package object back to the package walk routine */
886
887 state->pkg.this_target_obj = target_object;
888
889 /* Store the object pointer in the parent package object */
890
891 *this_target_ptr = target_object;
892 break;
893
894 default:
895
896 return (AE_BAD_PARAMETER);
897 }
898
899 return (status);
900
901error_exit:
902 acpi_ut_remove_reference(target_object);
903 return (status);
904}
905
906/*******************************************************************************
907 *
908 * FUNCTION: acpi_ut_copy_ipackage_to_ipackage
909 *
910 * PARAMETERS: source_obj - Pointer to the source package object
911 * dest_obj - Where the internal object is returned
912 * walk_state - Current Walk state descriptor
913 *
914 * RETURN: Status
915 *
916 * DESCRIPTION: This function is called to copy an internal package object
917 * into another internal package object.
918 *
919 ******************************************************************************/
920
921static acpi_status
922acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
923 union acpi_operand_object *dest_obj,
924 struct acpi_walk_state *walk_state)
925{
926 acpi_status status = AE_OK;
927
928 ACPI_FUNCTION_TRACE(ut_copy_ipackage_to_ipackage);
929
930 dest_obj->common.type = source_obj->common.type;
931 dest_obj->common.flags = source_obj->common.flags;
932 dest_obj->package.count = source_obj->package.count;
933
934 /*
935 * Create the object array and walk the source package tree
936 */
937 dest_obj->package.elements = ACPI_ALLOCATE_ZEROED(((acpi_size)
938 source_obj->package.
939 count +
940 1) * sizeof(void *));
941 if (!dest_obj->package.elements) {
942 ACPI_ERROR((AE_INFO, "Package allocation failure"));
943 return_ACPI_STATUS(AE_NO_MEMORY);
944 }
945
946 /*
947 * Copy the package element-by-element by walking the package "tree".
948 * This handles nested packages of arbitrary depth.
949 */
950 status = acpi_ut_walk_package_tree(source_obj, dest_obj,
951 acpi_ut_copy_ielement_to_ielement,
952 walk_state);
953 if (ACPI_FAILURE(status)) {
954
955 /* On failure, delete the destination package object */
956
957 acpi_ut_remove_reference(dest_obj);
958 }
959
960 return_ACPI_STATUS(status);
961}
962
963/*******************************************************************************
964 *
965 * FUNCTION: acpi_ut_copy_iobject_to_iobject
966 *
967 * PARAMETERS: source_desc - The internal object to be copied
968 * dest_desc - Where the copied object is returned
969 * walk_state - Current walk state
970 *
971 * RETURN: Status
972 *
973 * DESCRIPTION: Copy an internal object to a new internal object
974 *
975 ******************************************************************************/
976
977acpi_status
978acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
979 union acpi_operand_object **dest_desc,
980 struct acpi_walk_state *walk_state)
981{
982 acpi_status status = AE_OK;
983
984 ACPI_FUNCTION_TRACE(ut_copy_iobject_to_iobject);
985
986 /* Create the top level object */
987
988 *dest_desc = acpi_ut_create_internal_object(source_desc->common.type);
989 if (!*dest_desc) {
990 return_ACPI_STATUS(AE_NO_MEMORY);
991 }
992
993 /* Copy the object and possible subobjects */
994
995 if (source_desc->common.type == ACPI_TYPE_PACKAGE) {
996 status =
997 acpi_ut_copy_ipackage_to_ipackage(source_desc, *dest_desc,
998 walk_state);
999 } else {
1000 status = acpi_ut_copy_simple_object(source_desc, *dest_desc);
1001 }
1002
1003 /* Delete the allocated object if copy failed */
1004
1005 if (ACPI_FAILURE(status)) {
1006 acpi_ut_remove_reference(*dest_desc);
1007 }
1008
1009 return_ACPI_STATUS(status);
1010}