utcopy.c revision 99679
1/******************************************************************************
2 *
3 * Module Name: utcopy - Internal to external object translation utilities
4 *              $Revision: 101 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#define __UTCOPY_C__
118
119#include "acpi.h"
120#include "acnamesp.h"
121#include "amlcode.h"
122
123
124#define _COMPONENT          ACPI_UTILITIES
125        ACPI_MODULE_NAME    ("utcopy")
126
127
128/*******************************************************************************
129 *
130 * FUNCTION:    AcpiUtCopyIsimpleToEsimple
131 *
132 * PARAMETERS:  *InternalObject     - Pointer to the object we are examining
133 *              *Buffer             - Where the object is returned
134 *              *SpaceUsed          - Where the data length is returned
135 *
136 * RETURN:      Status
137 *
138 * DESCRIPTION: This function is called to place a simple object in a user
139 *              buffer.
140 *
141 *              The buffer is assumed to have sufficient space for the object.
142 *
143 ******************************************************************************/
144
145static ACPI_STATUS
146AcpiUtCopyIsimpleToEsimple (
147    ACPI_OPERAND_OBJECT     *InternalObject,
148    ACPI_OBJECT             *ExternalObject,
149    UINT8                   *DataSpace,
150    ACPI_SIZE               *BufferSpaceUsed)
151{
152    ACPI_STATUS             Status = AE_OK;
153
154
155    ACPI_FUNCTION_TRACE ("UtCopyIsimpleToEsimple");
156
157
158    *BufferSpaceUsed = 0;
159
160    /*
161     * Check for NULL object case (could be an uninitialized
162     * package element)
163     */
164    if (!InternalObject)
165    {
166        return_ACPI_STATUS (AE_OK);
167    }
168
169    /* Always clear the external object */
170
171    ACPI_MEMSET (ExternalObject, 0, sizeof (ACPI_OBJECT));
172
173    /*
174     * In general, the external object will be the same type as
175     * the internal object
176     */
177    ExternalObject->Type = ACPI_GET_OBJECT_TYPE (InternalObject);
178
179    /* However, only a limited number of external types are supported */
180
181    switch (ACPI_GET_OBJECT_TYPE (InternalObject))
182    {
183    case ACPI_TYPE_STRING:
184
185        ExternalObject->String.Pointer = (NATIVE_CHAR *) DataSpace;
186        ExternalObject->String.Length  = InternalObject->String.Length;
187        *BufferSpaceUsed = ACPI_ROUND_UP_TO_NATIVE_WORD ((ACPI_SIZE) InternalObject->String.Length + 1);
188
189        ACPI_MEMCPY ((void *) DataSpace, (void *) InternalObject->String.Pointer,
190                    (ACPI_SIZE) InternalObject->String.Length + 1);
191        break;
192
193
194    case ACPI_TYPE_BUFFER:
195
196        ExternalObject->Buffer.Pointer = DataSpace;
197        ExternalObject->Buffer.Length  = InternalObject->Buffer.Length;
198        *BufferSpaceUsed = ACPI_ROUND_UP_TO_NATIVE_WORD (InternalObject->String.Length);
199
200        ACPI_MEMCPY ((void *) DataSpace, (void *) InternalObject->Buffer.Pointer,
201                    InternalObject->Buffer.Length);
202        break;
203
204
205    case ACPI_TYPE_INTEGER:
206
207        ExternalObject->Integer.Value = InternalObject->Integer.Value;
208        break;
209
210
211    case INTERNAL_TYPE_REFERENCE:
212
213        /*
214         * This is an object reference.  Attempt to dereference it.
215         */
216        switch (InternalObject->Reference.Opcode)
217        {
218        case AML_INT_NAMEPATH_OP:
219
220            /* For namepath, return the object handle ("reference") */
221
222        default:
223            /*
224             * Use the object type of "Any" to indicate a reference
225             * to object containing a handle to an ACPI named object.
226             */
227            ExternalObject->Type = ACPI_TYPE_ANY;
228            ExternalObject->Reference.Handle = InternalObject->Reference.Node;
229            break;
230        }
231        break;
232
233
234    case ACPI_TYPE_PROCESSOR:
235
236        ExternalObject->Processor.ProcId      = InternalObject->Processor.ProcId;
237        ExternalObject->Processor.PblkAddress = InternalObject->Processor.Address;
238        ExternalObject->Processor.PblkLength  = InternalObject->Processor.Length;
239        break;
240
241
242    case ACPI_TYPE_POWER:
243
244        ExternalObject->PowerResource.SystemLevel =
245                            InternalObject->PowerResource.SystemLevel;
246
247        ExternalObject->PowerResource.ResourceOrder =
248                            InternalObject->PowerResource.ResourceOrder;
249        break;
250
251
252    default:
253        /*
254         * There is no corresponding external object type
255         */
256        return_ACPI_STATUS (AE_SUPPORT);
257    }
258
259    return_ACPI_STATUS (Status);
260}
261
262
263/*******************************************************************************
264 *
265 * FUNCTION:    AcpiUtCopyIelementToEelement
266 *
267 * PARAMETERS:  ACPI_PKG_CALLBACK
268 *
269 * RETURN:      Status
270 *
271 * DESCRIPTION: Copy one package element to another package element
272 *
273 ******************************************************************************/
274
275ACPI_STATUS
276AcpiUtCopyIelementToEelement (
277    UINT8                   ObjectType,
278    ACPI_OPERAND_OBJECT     *SourceObject,
279    ACPI_GENERIC_STATE      *State,
280    void                    *Context)
281{
282    ACPI_STATUS             Status = AE_OK;
283    ACPI_PKG_INFO           *Info = (ACPI_PKG_INFO *) Context;
284    ACPI_SIZE               ObjectSpace;
285    UINT32                  ThisIndex;
286    ACPI_OBJECT             *TargetObject;
287
288
289    ACPI_FUNCTION_ENTRY ();
290
291
292    ThisIndex    = State->Pkg.Index;
293    TargetObject = (ACPI_OBJECT *)
294                    &((ACPI_OBJECT *)(State->Pkg.DestObject))->Package.Elements[ThisIndex];
295
296    switch (ObjectType)
297    {
298    case ACPI_COPY_TYPE_SIMPLE:
299
300        /*
301         * This is a simple or null object
302         */
303        Status = AcpiUtCopyIsimpleToEsimple (SourceObject,
304                        TargetObject, Info->FreeSpace, &ObjectSpace);
305        if (ACPI_FAILURE (Status))
306        {
307            return (Status);
308        }
309        break;
310
311
312    case ACPI_COPY_TYPE_PACKAGE:
313
314        /*
315         * Build the package object
316         */
317        TargetObject->Type              = ACPI_TYPE_PACKAGE;
318        TargetObject->Package.Count     = SourceObject->Package.Count;
319        TargetObject->Package.Elements  = ACPI_CAST_PTR (ACPI_OBJECT, Info->FreeSpace);
320
321        /*
322         * Pass the new package object back to the package walk routine
323         */
324        State->Pkg.ThisTargetObj = TargetObject;
325
326        /*
327         * Save space for the array of objects (Package elements)
328         * update the buffer length counter
329         */
330        ObjectSpace = ACPI_ROUND_UP_TO_NATIVE_WORD (
331                            (ACPI_SIZE) TargetObject->Package.Count * sizeof (ACPI_OBJECT));
332        break;
333
334
335    default:
336        return (AE_BAD_PARAMETER);
337    }
338
339    Info->FreeSpace   += ObjectSpace;
340    Info->Length      += ObjectSpace;
341    return (Status);
342}
343
344
345/*******************************************************************************
346 *
347 * FUNCTION:    AcpiUtCopyIpackageToEpackage
348 *
349 * PARAMETERS:  *InternalObject     - Pointer to the object we are returning
350 *              *Buffer             - Where the object is returned
351 *              *SpaceUsed          - Where the object length is returned
352 *
353 * RETURN:      Status
354 *
355 * DESCRIPTION: This function is called to place a package object in a user
356 *              buffer.  A package object by definition contains other objects.
357 *
358 *              The buffer is assumed to have sufficient space for the object.
359 *              The caller must have verified the buffer length needed using the
360 *              AcpiUtGetObjectSize function before calling this function.
361 *
362 ******************************************************************************/
363
364static ACPI_STATUS
365AcpiUtCopyIpackageToEpackage (
366    ACPI_OPERAND_OBJECT     *InternalObject,
367    UINT8                   *Buffer,
368    ACPI_SIZE               *SpaceUsed)
369{
370    ACPI_OBJECT             *ExternalObject;
371    ACPI_STATUS             Status;
372    ACPI_PKG_INFO           Info;
373
374
375    ACPI_FUNCTION_TRACE ("UtCopyIpackageToEpackage");
376
377
378    /*
379     * First package at head of the buffer
380     */
381    ExternalObject = ACPI_CAST_PTR (ACPI_OBJECT, Buffer);
382
383    /*
384     * Free space begins right after the first package
385     */
386    Info.Length      = 0;
387    Info.ObjectSpace = 0;
388    Info.NumPackages = 1;
389    Info.FreeSpace   = Buffer + ACPI_ROUND_UP_TO_NATIVE_WORD (sizeof (ACPI_OBJECT));
390
391    ExternalObject->Type               = ACPI_GET_OBJECT_TYPE (InternalObject);
392    ExternalObject->Package.Count      = InternalObject->Package.Count;
393    ExternalObject->Package.Elements   = ACPI_CAST_PTR (ACPI_OBJECT, Info.FreeSpace);
394
395    /*
396     * Build an array of ACPI_OBJECTS in the buffer
397     * and move the free space past it
398     */
399    Info.FreeSpace += ExternalObject->Package.Count *
400                    ACPI_ROUND_UP_TO_NATIVE_WORD (sizeof (ACPI_OBJECT));
401
402    Status = AcpiUtWalkPackageTree (InternalObject, ExternalObject,
403                            AcpiUtCopyIelementToEelement, &Info);
404
405    *SpaceUsed = Info.Length;
406    return_ACPI_STATUS (Status);
407}
408
409
410/*******************************************************************************
411 *
412 * FUNCTION:    AcpiUtCopyIobjectToEobject
413 *
414 * PARAMETERS:  *InternalObject     - The internal object to be converted
415 *              *BufferPtr          - Where the object is returned
416 *
417 * RETURN:      Status
418 *
419 * DESCRIPTION: This function is called to build an API object to be returned to
420 *              the caller.
421 *
422 ******************************************************************************/
423
424ACPI_STATUS
425AcpiUtCopyIobjectToEobject (
426    ACPI_OPERAND_OBJECT     *InternalObject,
427    ACPI_BUFFER             *RetBuffer)
428{
429    ACPI_STATUS             Status;
430
431
432    ACPI_FUNCTION_TRACE ("UtCopyIobjectToEobject");
433
434
435    if (ACPI_GET_OBJECT_TYPE (InternalObject) == ACPI_TYPE_PACKAGE)
436    {
437        /*
438         * Package object:  Copy all subobjects (including
439         * nested packages)
440         */
441        Status = AcpiUtCopyIpackageToEpackage (InternalObject,
442                        RetBuffer->Pointer, &RetBuffer->Length);
443    }
444    else
445    {
446        /*
447         * Build a simple object (no nested objects)
448         */
449        Status = AcpiUtCopyIsimpleToEsimple (InternalObject,
450                        (ACPI_OBJECT *) RetBuffer->Pointer,
451                        ((UINT8 *) RetBuffer->Pointer +
452                        ACPI_ROUND_UP_TO_NATIVE_WORD (sizeof (ACPI_OBJECT))),
453                        &RetBuffer->Length);
454        /*
455         * build simple does not include the object size in the length
456         * so we add it in here
457         */
458        RetBuffer->Length += sizeof (ACPI_OBJECT);
459    }
460
461    return_ACPI_STATUS (Status);
462}
463
464
465/*******************************************************************************
466 *
467 * FUNCTION:    AcpiUtCopyEsimpleToIsimple
468 *
469 * PARAMETERS:  *ExternalObject    - The external object to be converted
470 *              *InternalObject    - Where the internal object is returned
471 *
472 * RETURN:      Status
473 *
474 * DESCRIPTION: This function copies an external object to an internal one.
475 *              NOTE: Pointers can be copied, we don't need to copy data.
476 *              (The pointers have to be valid in our address space no matter
477 *              what we do with them!)
478 *
479 ******************************************************************************/
480
481ACPI_STATUS
482AcpiUtCopyEsimpleToIsimple (
483    ACPI_OBJECT             *ExternalObject,
484    ACPI_OPERAND_OBJECT     **RetInternalObject)
485{
486    ACPI_OPERAND_OBJECT     *InternalObject;
487
488
489    ACPI_FUNCTION_TRACE ("UtCopyEsimpleToIsimple");
490
491
492    /*
493     * Simple types supported are: String, Buffer, Integer
494     */
495    switch (ExternalObject->Type)
496    {
497    case ACPI_TYPE_STRING:
498    case ACPI_TYPE_BUFFER:
499    case ACPI_TYPE_INTEGER:
500
501        InternalObject = AcpiUtCreateInternalObject ((UINT8) ExternalObject->Type);
502        if (!InternalObject)
503        {
504            return_ACPI_STATUS (AE_NO_MEMORY);
505        }
506        break;
507
508    default:
509        /*
510         * Whatever other type -- it is not supported
511         */
512        return_ACPI_STATUS (AE_SUPPORT);
513    }
514
515
516    switch (ExternalObject->Type)
517    {
518
519    /* Must COPY string and buffer contents */
520
521    case ACPI_TYPE_STRING:
522
523        InternalObject->String.Pointer = ACPI_MEM_CALLOCATE ((ACPI_SIZE) ExternalObject->String.Length + 1);
524        if (!InternalObject->String.Pointer)
525        {
526            return_ACPI_STATUS (AE_NO_MEMORY);
527        }
528
529        ACPI_MEMCPY (InternalObject->String.Pointer,
530                     ExternalObject->String.Pointer,
531                     ExternalObject->String.Length);
532
533        InternalObject->String.Length  = ExternalObject->String.Length;
534        break;
535
536
537    case ACPI_TYPE_BUFFER:
538
539        InternalObject->Buffer.Pointer = ACPI_MEM_CALLOCATE (ExternalObject->Buffer.Length);
540        if (!InternalObject->Buffer.Pointer)
541        {
542            return_ACPI_STATUS (AE_NO_MEMORY);
543        }
544
545        ACPI_MEMCPY (InternalObject->Buffer.Pointer,
546                     ExternalObject->Buffer.Pointer,
547                     ExternalObject->Buffer.Length);
548
549        InternalObject->Buffer.Length  = ExternalObject->Buffer.Length;
550        break;
551
552
553    case ACPI_TYPE_INTEGER:
554
555        InternalObject->Integer.Value   = ExternalObject->Integer.Value;
556        break;
557
558    default:
559        /* Other types can't get here */
560        break;
561    }
562
563    *RetInternalObject = InternalObject;
564    return_ACPI_STATUS (AE_OK);
565}
566
567
568#ifdef ACPI_FUTURE_IMPLEMENTATION
569
570/* Code to convert packages that are parameters to control methods */
571
572/*******************************************************************************
573 *
574 * FUNCTION:    AcpiUtCopyEpackageToIpackage
575 *
576 * PARAMETERS:  *InternalObject    - Pointer to the object we are returning
577 *              *Buffer         - Where the object is returned
578 *              *SpaceUsed      - Where the length of the object is returned
579 *
580 * RETURN:      Status          - the status of the call
581 *
582 * DESCRIPTION: This function is called to place a package object in a user
583 *              buffer.  A package object by definition contains other objects.
584 *
585 *              The buffer is assumed to have sufficient space for the object.
586 *              The caller must have verified the buffer length needed using the
587 *              AcpiUtGetObjectSize function before calling this function.
588 *
589 ******************************************************************************/
590
591static ACPI_STATUS
592AcpiUtCopyEpackageToIpackage (
593    ACPI_OPERAND_OBJECT     *InternalObject,
594    UINT8                   *Buffer,
595    UINT32                  *SpaceUsed)
596{
597    UINT8                   *FreeSpace;
598    ACPI_OBJECT             *ExternalObject;
599    UINT32                  Length = 0;
600    UINT32                  ThisIndex;
601    UINT32                  ObjectSpace = 0;
602    ACPI_OPERAND_OBJECT     *ThisInternalObj;
603    ACPI_OBJECT             *ThisExternalObj;
604
605
606    ACPI_FUNCTION_TRACE ("UtCopyEpackageToIpackage");
607
608
609    /*
610     * First package at head of the buffer
611     */
612    ExternalObject = (ACPI_OBJECT *)Buffer;
613
614    /*
615     * Free space begins right after the first package
616     */
617    FreeSpace = Buffer + sizeof(ACPI_OBJECT);
618
619
620    ExternalObject->Type               = ACPI_GET_OBJECT_TYPE (InternalObject);
621    ExternalObject->Package.Count      = InternalObject->Package.Count;
622    ExternalObject->Package.Elements   = (ACPI_OBJECT *)FreeSpace;
623
624
625    /*
626     * Build an array of ACPI_OBJECTS in the buffer
627     * and move the free space past it
628     */
629    FreeSpace += ExternalObject->Package.Count * sizeof(ACPI_OBJECT);
630
631
632    /* Call WalkPackage */
633
634}
635
636#endif /* Future implementation */
637
638
639/*******************************************************************************
640 *
641 * FUNCTION:    AcpiUtCopyEobjectToIobject
642 *
643 * PARAMETERS:  *InternalObject    - The external object to be converted
644 *              *BufferPtr      - Where the internal object is returned
645 *
646 * RETURN:      Status          - the status of the call
647 *
648 * DESCRIPTION: Converts an external object to an internal object.
649 *
650 ******************************************************************************/
651
652ACPI_STATUS
653AcpiUtCopyEobjectToIobject (
654    ACPI_OBJECT             *ExternalObject,
655    ACPI_OPERAND_OBJECT     **InternalObject)
656{
657    ACPI_STATUS             Status;
658
659
660    ACPI_FUNCTION_TRACE ("UtCopyEobjectToIobject");
661
662
663    if (ExternalObject->Type == ACPI_TYPE_PACKAGE)
664    {
665        /*
666         * Packages as external input to control methods are not supported,
667         */
668        ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
669            "Packages as parameters not implemented!\n"));
670
671        return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
672    }
673
674    else
675    {
676        /*
677         * Build a simple object (no nested objects)
678         */
679        Status = AcpiUtCopyEsimpleToIsimple (ExternalObject, InternalObject);
680    }
681
682    return_ACPI_STATUS (Status);
683}
684
685
686/*******************************************************************************
687 *
688 * FUNCTION:    AcpiUtCopySimpleObject
689 *
690 * PARAMETERS:  SourceDesc          - The internal object to be copied
691 *              DestDesc            - New target object
692 *
693 * RETURN:      Status
694 *
695 * DESCRIPTION: Simple copy of one internal object to another.  Reference count
696 *              of the destination object is preserved.
697 *
698 ******************************************************************************/
699
700ACPI_STATUS
701AcpiUtCopySimpleObject (
702    ACPI_OPERAND_OBJECT     *SourceDesc,
703    ACPI_OPERAND_OBJECT     *DestDesc)
704{
705    UINT16                  ReferenceCount;
706    ACPI_OPERAND_OBJECT     *NextObject;
707
708
709    /* Save fields from destination that we don't want to overwrite */
710
711    ReferenceCount = DestDesc->Common.ReferenceCount;
712    NextObject = DestDesc->Common.NextObject;
713
714    /* Copy the entire source object over the destination object*/
715
716    ACPI_MEMCPY ((char *) DestDesc, (char *) SourceDesc, sizeof (ACPI_OPERAND_OBJECT));
717
718    /* Restore the saved fields */
719
720    DestDesc->Common.ReferenceCount = ReferenceCount;
721    DestDesc->Common.NextObject = NextObject;
722
723    /* Handle the objects with extra data */
724
725    switch (ACPI_GET_OBJECT_TYPE (DestDesc))
726    {
727    case ACPI_TYPE_BUFFER:
728
729        DestDesc->Buffer.Node = NULL;
730        DestDesc->Common.Flags = SourceDesc->Common.Flags;
731
732        /* Fall through to common string/buffer case */
733        /*lint -fallthrough */
734
735    case ACPI_TYPE_STRING:
736
737        /*
738         * Allocate and copy the actual string if and only if:
739         * 1) There is a valid string (length > 0)
740         * 2) The string is not static (not in an ACPI table) (in this case,
741         *    the actual pointer was already copied above)
742         */
743        if ((SourceDesc->String.Length) &&
744            (!(SourceDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
745        {
746            DestDesc->String.Pointer = ACPI_MEM_ALLOCATE (SourceDesc->String.Length);
747            if (!DestDesc->String.Pointer)
748            {
749                return (AE_NO_MEMORY);
750            }
751
752            ACPI_MEMCPY (DestDesc->String.Pointer, SourceDesc->String.Pointer,
753                         SourceDesc->String.Length);
754        }
755        break;
756
757    default:
758        /* Nothing to do for other simple objects */
759        break;
760    }
761
762    return (AE_OK);
763}
764
765
766/*******************************************************************************
767 *
768 * FUNCTION:    AcpiUtCopyIelementToIelement
769 *
770 * PARAMETERS:  ACPI_PKG_CALLBACK
771 *
772 * RETURN:      Status
773 *
774 * DESCRIPTION: Copy one package element to another package element
775 *
776 ******************************************************************************/
777
778ACPI_STATUS
779AcpiUtCopyIelementToIelement (
780    UINT8                   ObjectType,
781    ACPI_OPERAND_OBJECT     *SourceObject,
782    ACPI_GENERIC_STATE      *State,
783    void                    *Context)
784{
785    ACPI_STATUS             Status = AE_OK;
786    UINT32                  ThisIndex;
787    ACPI_OPERAND_OBJECT     **ThisTargetPtr;
788    ACPI_OPERAND_OBJECT     *TargetObject;
789
790
791    ACPI_FUNCTION_ENTRY ();
792
793
794    ThisIndex     = State->Pkg.Index;
795    ThisTargetPtr = (ACPI_OPERAND_OBJECT **)
796                        &State->Pkg.DestObject->Package.Elements[ThisIndex];
797
798    switch (ObjectType)
799    {
800    case 0:
801
802        /*
803         * This is a simple object, just copy it
804         */
805        TargetObject = AcpiUtCreateInternalObject (ACPI_GET_OBJECT_TYPE (SourceObject));
806        if (!TargetObject)
807        {
808            return (AE_NO_MEMORY);
809        }
810
811        Status = AcpiUtCopySimpleObject (SourceObject, TargetObject);
812        if (ACPI_FAILURE (Status))
813        {
814            return (Status);
815        }
816
817        *ThisTargetPtr = TargetObject;
818        break;
819
820
821    case 1:
822
823        /*
824         * This object is a package - go down another nesting level
825         * Create and build the package object
826         */
827        TargetObject = AcpiUtCreateInternalObject (ACPI_TYPE_PACKAGE);
828        if (!TargetObject)
829        {
830            return (AE_NO_MEMORY);
831        }
832
833        TargetObject->Package.Count = SourceObject->Package.Count;
834        TargetObject->Common.Flags  = SourceObject->Common.Flags;
835
836        /*
837         * Pass the new package object back to the package walk routine
838         */
839        State->Pkg.ThisTargetObj = TargetObject;
840
841        /*
842         * Store the object pointer in the parent package object
843         */
844        *ThisTargetPtr = TargetObject;
845        break;
846
847
848    default:
849        return (AE_BAD_PARAMETER);
850    }
851
852    return (Status);
853}
854
855
856/*******************************************************************************
857 *
858 * FUNCTION:    AcpiUtCopyIpackageToIpackage
859 *
860 * PARAMETERS:  *SourceObj      - Pointer to the source package object
861 *              *DestObj        - Where the internal object is returned
862 *
863 * RETURN:      Status          - the status of the call
864 *
865 * DESCRIPTION: This function is called to copy an internal package object
866 *              into another internal package object.
867 *
868 ******************************************************************************/
869
870ACPI_STATUS
871AcpiUtCopyIpackageToIpackage (
872    ACPI_OPERAND_OBJECT     *SourceObj,
873    ACPI_OPERAND_OBJECT     *DestObj,
874    ACPI_WALK_STATE         *WalkState)
875{
876    ACPI_STATUS             Status = AE_OK;
877
878
879    ACPI_FUNCTION_TRACE ("UtCopyIpackageToIpackage");
880
881
882    DestObj->Common.Type    = ACPI_GET_OBJECT_TYPE (SourceObj);
883    DestObj->Common.Flags   = SourceObj->Common.Flags;
884    DestObj->Package.Count  = SourceObj->Package.Count;
885
886    /*
887     * Create the object array and walk the source package tree
888     */
889    DestObj->Package.Elements = ACPI_MEM_CALLOCATE (
890                                    ((ACPI_SIZE) SourceObj->Package.Count + 1) *
891                                    sizeof (void *));
892    if (!DestObj->Package.Elements)
893    {
894        ACPI_REPORT_ERROR (
895            ("AmlBuildCopyInternalPackageObject: Package allocation failure\n"));
896        return_ACPI_STATUS (AE_NO_MEMORY);
897    }
898
899    /*
900     * Copy the package element-by-element by walking the package "tree".
901     * This handles nested packages of arbitrary depth.
902     */
903    Status = AcpiUtWalkPackageTree (SourceObj, DestObj,
904                            AcpiUtCopyIelementToIelement, WalkState);
905    if (ACPI_FAILURE (Status))
906    {
907        /* On failure, delete the destination package object */
908
909        AcpiUtRemoveReference (DestObj);
910    }
911
912    return_ACPI_STATUS (Status);
913}
914
915
916/*******************************************************************************
917 *
918 * FUNCTION:    AcpiUtCopyIobjectToIobject
919 *
920 * PARAMETERS:  WalkState           - Current walk state
921 *              SourceDesc          - The internal object to be copied
922 *              DestDesc            - Where the copied object is returned
923 *
924 * RETURN:      Status
925 *
926 * DESCRIPTION: Copy an internal object to a new internal object
927 *
928 ******************************************************************************/
929
930ACPI_STATUS
931AcpiUtCopyIobjectToIobject (
932    ACPI_OPERAND_OBJECT     *SourceDesc,
933    ACPI_OPERAND_OBJECT     **DestDesc,
934    ACPI_WALK_STATE         *WalkState)
935{
936    ACPI_STATUS             Status = AE_OK;
937
938
939    ACPI_FUNCTION_TRACE ("UtCopyIobjectToIobject");
940
941
942    /* Create the top level object */
943
944    *DestDesc = AcpiUtCreateInternalObject (ACPI_GET_OBJECT_TYPE (SourceDesc));
945    if (!*DestDesc)
946    {
947        return_ACPI_STATUS (AE_NO_MEMORY);
948    }
949
950    /* Copy the object and possible subobjects */
951
952    if (ACPI_GET_OBJECT_TYPE (SourceDesc) == ACPI_TYPE_PACKAGE)
953    {
954        Status = AcpiUtCopyIpackageToIpackage (SourceDesc, *DestDesc,
955                        WalkState);
956    }
957    else
958    {
959        Status = AcpiUtCopySimpleObject (SourceDesc, *DestDesc);
960    }
961
962    return_ACPI_STATUS (Status);
963}
964
965
966