xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utobject.c (revision 220d04022750f40f8bac8f01fa551211e28d04f2)
1 /******************************************************************************
2  *
3  * Module Name: utobject - ACPI object create/delete/size/cache routines
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2013, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define __UTOBJECT_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acnamesp.h"
121 
122 
123 #define _COMPONENT          ACPI_UTILITIES
124         ACPI_MODULE_NAME    ("utobject")
125 
126 /* Local prototypes */
127 
128 static ACPI_STATUS
129 AcpiUtGetSimpleObjectSize (
130     ACPI_OPERAND_OBJECT     *Obj,
131     ACPI_SIZE               *ObjLength);
132 
133 static ACPI_STATUS
134 AcpiUtGetPackageObjectSize (
135     ACPI_OPERAND_OBJECT     *Obj,
136     ACPI_SIZE               *ObjLength);
137 
138 static ACPI_STATUS
139 AcpiUtGetElementLength (
140     UINT8                   ObjectType,
141     ACPI_OPERAND_OBJECT     *SourceObject,
142     ACPI_GENERIC_STATE      *State,
143     void                    *Context);
144 
145 
146 /*******************************************************************************
147  *
148  * FUNCTION:    AcpiUtCreateInternalObjectDbg
149  *
150  * PARAMETERS:  ModuleName          - Source file name of caller
151  *              LineNumber          - Line number of caller
152  *              ComponentId         - Component type of caller
153  *              Type                - ACPI Type of the new object
154  *
155  * RETURN:      A new internal object, null on failure
156  *
157  * DESCRIPTION: Create and initialize a new internal object.
158  *
159  * NOTE:        We always allocate the worst-case object descriptor because
160  *              these objects are cached, and we want them to be
161  *              one-size-satisifies-any-request. This in itself may not be
162  *              the most memory efficient, but the efficiency of the object
163  *              cache should more than make up for this!
164  *
165  ******************************************************************************/
166 
167 ACPI_OPERAND_OBJECT  *
168 AcpiUtCreateInternalObjectDbg (
169     const char              *ModuleName,
170     UINT32                  LineNumber,
171     UINT32                  ComponentId,
172     ACPI_OBJECT_TYPE        Type)
173 {
174     ACPI_OPERAND_OBJECT     *Object;
175     ACPI_OPERAND_OBJECT     *SecondObject;
176 
177 
178     ACPI_FUNCTION_TRACE_STR (UtCreateInternalObjectDbg,
179         AcpiUtGetTypeName (Type));
180 
181 
182     /* Allocate the raw object descriptor */
183 
184     Object = AcpiUtAllocateObjectDescDbg (ModuleName, LineNumber, ComponentId);
185     if (!Object)
186     {
187         return_PTR (NULL);
188     }
189 
190     switch (Type)
191     {
192     case ACPI_TYPE_REGION:
193     case ACPI_TYPE_BUFFER_FIELD:
194     case ACPI_TYPE_LOCAL_BANK_FIELD:
195 
196         /* These types require a secondary object */
197 
198         SecondObject = AcpiUtAllocateObjectDescDbg (ModuleName,
199                             LineNumber, ComponentId);
200         if (!SecondObject)
201         {
202             AcpiUtDeleteObjectDesc (Object);
203             return_PTR (NULL);
204         }
205 
206         SecondObject->Common.Type = ACPI_TYPE_LOCAL_EXTRA;
207         SecondObject->Common.ReferenceCount = 1;
208 
209         /* Link the second object to the first */
210 
211         Object->Common.NextObject = SecondObject;
212         break;
213 
214     default:
215 
216         /* All others have no secondary object */
217         break;
218     }
219 
220     /* Save the object type in the object descriptor */
221 
222     Object->Common.Type = (UINT8) Type;
223 
224     /* Init the reference count */
225 
226     Object->Common.ReferenceCount = 1;
227 
228     /* Any per-type initialization should go here */
229 
230     return_PTR (Object);
231 }
232 
233 
234 /*******************************************************************************
235  *
236  * FUNCTION:    AcpiUtCreatePackageObject
237  *
238  * PARAMETERS:  Count               - Number of package elements
239  *
240  * RETURN:      Pointer to a new Package object, null on failure
241  *
242  * DESCRIPTION: Create a fully initialized package object
243  *
244  ******************************************************************************/
245 
246 ACPI_OPERAND_OBJECT *
247 AcpiUtCreatePackageObject (
248     UINT32                  Count)
249 {
250     ACPI_OPERAND_OBJECT     *PackageDesc;
251     ACPI_OPERAND_OBJECT     **PackageElements;
252 
253 
254     ACPI_FUNCTION_TRACE_U32 (UtCreatePackageObject, Count);
255 
256 
257     /* Create a new Package object */
258 
259     PackageDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PACKAGE);
260     if (!PackageDesc)
261     {
262         return_PTR (NULL);
263     }
264 
265     /*
266      * Create the element array. Count+1 allows the array to be null
267      * terminated.
268      */
269     PackageElements = ACPI_ALLOCATE_ZEROED (
270                         ((ACPI_SIZE) Count + 1) * sizeof (void *));
271     if (!PackageElements)
272     {
273         ACPI_FREE (PackageDesc);
274         return_PTR (NULL);
275     }
276 
277     PackageDesc->Package.Count = Count;
278     PackageDesc->Package.Elements = PackageElements;
279     return_PTR (PackageDesc);
280 }
281 
282 
283 /*******************************************************************************
284  *
285  * FUNCTION:    AcpiUtCreateIntegerObject
286  *
287  * PARAMETERS:  InitialValue        - Initial value for the integer
288  *
289  * RETURN:      Pointer to a new Integer object, null on failure
290  *
291  * DESCRIPTION: Create an initialized integer object
292  *
293  ******************************************************************************/
294 
295 ACPI_OPERAND_OBJECT *
296 AcpiUtCreateIntegerObject (
297     UINT64                  InitialValue)
298 {
299     ACPI_OPERAND_OBJECT     *IntegerDesc;
300 
301 
302     ACPI_FUNCTION_TRACE (UtCreateIntegerObject);
303 
304 
305     /* Create and initialize a new integer object */
306 
307     IntegerDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
308     if (!IntegerDesc)
309     {
310         return_PTR (NULL);
311     }
312 
313     IntegerDesc->Integer.Value = InitialValue;
314     return_PTR (IntegerDesc);
315 }
316 
317 
318 /*******************************************************************************
319  *
320  * FUNCTION:    AcpiUtCreateBufferObject
321  *
322  * PARAMETERS:  BufferSize             - Size of buffer to be created
323  *
324  * RETURN:      Pointer to a new Buffer object, null on failure
325  *
326  * DESCRIPTION: Create a fully initialized buffer object
327  *
328  ******************************************************************************/
329 
330 ACPI_OPERAND_OBJECT *
331 AcpiUtCreateBufferObject (
332     ACPI_SIZE               BufferSize)
333 {
334     ACPI_OPERAND_OBJECT     *BufferDesc;
335     UINT8                   *Buffer = NULL;
336 
337 
338     ACPI_FUNCTION_TRACE_U32 (UtCreateBufferObject, BufferSize);
339 
340 
341     /* Create a new Buffer object */
342 
343     BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
344     if (!BufferDesc)
345     {
346         return_PTR (NULL);
347     }
348 
349     /* Create an actual buffer only if size > 0 */
350 
351     if (BufferSize > 0)
352     {
353         /* Allocate the actual buffer */
354 
355         Buffer = ACPI_ALLOCATE_ZEROED (BufferSize);
356         if (!Buffer)
357         {
358             ACPI_ERROR ((AE_INFO, "Could not allocate size %u",
359                 (UINT32) BufferSize));
360             AcpiUtRemoveReference (BufferDesc);
361             return_PTR (NULL);
362         }
363     }
364 
365     /* Complete buffer object initialization */
366 
367     BufferDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
368     BufferDesc->Buffer.Pointer = Buffer;
369     BufferDesc->Buffer.Length = (UINT32) BufferSize;
370 
371     /* Return the new buffer descriptor */
372 
373     return_PTR (BufferDesc);
374 }
375 
376 
377 /*******************************************************************************
378  *
379  * FUNCTION:    AcpiUtCreateStringObject
380  *
381  * PARAMETERS:  StringSize          - Size of string to be created. Does not
382  *                                    include NULL terminator, this is added
383  *                                    automatically.
384  *
385  * RETURN:      Pointer to a new String object
386  *
387  * DESCRIPTION: Create a fully initialized string object
388  *
389  ******************************************************************************/
390 
391 ACPI_OPERAND_OBJECT *
392 AcpiUtCreateStringObject (
393     ACPI_SIZE               StringSize)
394 {
395     ACPI_OPERAND_OBJECT     *StringDesc;
396     char                    *String;
397 
398 
399     ACPI_FUNCTION_TRACE_U32 (UtCreateStringObject, StringSize);
400 
401 
402     /* Create a new String object */
403 
404     StringDesc = AcpiUtCreateInternalObject (ACPI_TYPE_STRING);
405     if (!StringDesc)
406     {
407         return_PTR (NULL);
408     }
409 
410     /*
411      * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
412      * NOTE: Zero-length strings are NULL terminated
413      */
414     String = ACPI_ALLOCATE_ZEROED (StringSize + 1);
415     if (!String)
416     {
417         ACPI_ERROR ((AE_INFO, "Could not allocate size %u",
418             (UINT32) StringSize));
419         AcpiUtRemoveReference (StringDesc);
420         return_PTR (NULL);
421     }
422 
423     /* Complete string object initialization */
424 
425     StringDesc->String.Pointer = String;
426     StringDesc->String.Length = (UINT32) StringSize;
427 
428     /* Return the new string descriptor */
429 
430     return_PTR (StringDesc);
431 }
432 
433 
434 /*******************************************************************************
435  *
436  * FUNCTION:    AcpiUtValidInternalObject
437  *
438  * PARAMETERS:  Object              - Object to be validated
439  *
440  * RETURN:      TRUE if object is valid, FALSE otherwise
441  *
442  * DESCRIPTION: Validate a pointer to be of type ACPI_OPERAND_OBJECT
443  *
444  ******************************************************************************/
445 
446 BOOLEAN
447 AcpiUtValidInternalObject (
448     void                    *Object)
449 {
450 
451     ACPI_FUNCTION_NAME (UtValidInternalObject);
452 
453 
454     /* Check for a null pointer */
455 
456     if (!Object)
457     {
458         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "**** Null Object Ptr\n"));
459         return (FALSE);
460     }
461 
462     /* Check the descriptor type field */
463 
464     switch (ACPI_GET_DESCRIPTOR_TYPE (Object))
465     {
466     case ACPI_DESC_TYPE_OPERAND:
467 
468         /* The object appears to be a valid ACPI_OPERAND_OBJECT */
469 
470         return (TRUE);
471 
472     default:
473 
474         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
475                 "%p is not not an ACPI operand obj [%s]\n",
476                 Object, AcpiUtGetDescriptorName (Object)));
477         break;
478     }
479 
480     return (FALSE);
481 }
482 
483 
484 /*******************************************************************************
485  *
486  * FUNCTION:    AcpiUtAllocateObjectDescDbg
487  *
488  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
489  *              LineNumber          - Caller's line number (for error output)
490  *              ComponentId         - Caller's component ID (for error output)
491  *
492  * RETURN:      Pointer to newly allocated object descriptor. Null on error
493  *
494  * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
495  *              error conditions.
496  *
497  ******************************************************************************/
498 
499 void *
500 AcpiUtAllocateObjectDescDbg (
501     const char              *ModuleName,
502     UINT32                  LineNumber,
503     UINT32                  ComponentId)
504 {
505     ACPI_OPERAND_OBJECT     *Object;
506 
507 
508     ACPI_FUNCTION_TRACE (UtAllocateObjectDescDbg);
509 
510 
511     Object = AcpiOsAcquireObject (AcpiGbl_OperandCache);
512     if (!Object)
513     {
514         ACPI_ERROR ((ModuleName, LineNumber,
515             "Could not allocate an object descriptor"));
516 
517         return_PTR (NULL);
518     }
519 
520     /* Mark the descriptor type */
521 
522     ACPI_SET_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_OPERAND);
523 
524     ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
525             Object, (UINT32) sizeof (ACPI_OPERAND_OBJECT)));
526 
527     return_PTR (Object);
528 }
529 
530 
531 /*******************************************************************************
532  *
533  * FUNCTION:    AcpiUtDeleteObjectDesc
534  *
535  * PARAMETERS:  Object          - An Acpi internal object to be deleted
536  *
537  * RETURN:      None.
538  *
539  * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
540  *
541  ******************************************************************************/
542 
543 void
544 AcpiUtDeleteObjectDesc (
545     ACPI_OPERAND_OBJECT     *Object)
546 {
547     ACPI_FUNCTION_TRACE_PTR (UtDeleteObjectDesc, Object);
548 
549 
550     /* Object must be of type ACPI_OPERAND_OBJECT */
551 
552     if (ACPI_GET_DESCRIPTOR_TYPE (Object) != ACPI_DESC_TYPE_OPERAND)
553     {
554         ACPI_ERROR ((AE_INFO,
555             "%p is not an ACPI Operand object [%s]", Object,
556             AcpiUtGetDescriptorName (Object)));
557         return_VOID;
558     }
559 
560     (void) AcpiOsReleaseObject (AcpiGbl_OperandCache, Object);
561     return_VOID;
562 }
563 
564 
565 /*******************************************************************************
566  *
567  * FUNCTION:    AcpiUtGetSimpleObjectSize
568  *
569  * PARAMETERS:  InternalObject     - An ACPI operand object
570  *              ObjLength          - Where the length is returned
571  *
572  * RETURN:      Status
573  *
574  * DESCRIPTION: This function is called to determine the space required to
575  *              contain a simple object for return to an external user.
576  *
577  *              The length includes the object structure plus any additional
578  *              needed space.
579  *
580  ******************************************************************************/
581 
582 static ACPI_STATUS
583 AcpiUtGetSimpleObjectSize (
584     ACPI_OPERAND_OBJECT     *InternalObject,
585     ACPI_SIZE               *ObjLength)
586 {
587     ACPI_SIZE               Length;
588     ACPI_SIZE               Size;
589     ACPI_STATUS             Status = AE_OK;
590 
591 
592     ACPI_FUNCTION_TRACE_PTR (UtGetSimpleObjectSize, InternalObject);
593 
594 
595     /* Start with the length of the (external) Acpi object */
596 
597     Length = sizeof (ACPI_OBJECT);
598 
599     /* A NULL object is allowed, can be a legal uninitialized package element */
600 
601     if (!InternalObject)
602     {
603         /*
604          * Object is NULL, just return the length of ACPI_OBJECT
605          * (A NULL ACPI_OBJECT is an object of all zeroes.)
606          */
607         *ObjLength = ACPI_ROUND_UP_TO_NATIVE_WORD (Length);
608         return_ACPI_STATUS (AE_OK);
609     }
610 
611     /* A Namespace Node should never appear here */
612 
613     if (ACPI_GET_DESCRIPTOR_TYPE (InternalObject) == ACPI_DESC_TYPE_NAMED)
614     {
615         /* A namespace node should never get here */
616 
617         return_ACPI_STATUS (AE_AML_INTERNAL);
618     }
619 
620     /*
621      * The final length depends on the object type
622      * Strings and Buffers are packed right up against the parent object and
623      * must be accessed bytewise or there may be alignment problems on
624      * certain processors
625      */
626     switch (InternalObject->Common.Type)
627     {
628     case ACPI_TYPE_STRING:
629 
630         Length += (ACPI_SIZE) InternalObject->String.Length + 1;
631         break;
632 
633     case ACPI_TYPE_BUFFER:
634 
635         Length += (ACPI_SIZE) InternalObject->Buffer.Length;
636         break;
637 
638     case ACPI_TYPE_INTEGER:
639     case ACPI_TYPE_PROCESSOR:
640     case ACPI_TYPE_POWER:
641 
642         /* No extra data for these types */
643 
644         break;
645 
646     case ACPI_TYPE_LOCAL_REFERENCE:
647 
648         switch (InternalObject->Reference.Class)
649         {
650         case ACPI_REFCLASS_NAME:
651             /*
652              * Get the actual length of the full pathname to this object.
653              * The reference will be converted to the pathname to the object
654              */
655             Size = AcpiNsGetPathnameLength (InternalObject->Reference.Node);
656             if (!Size)
657             {
658                 return_ACPI_STATUS (AE_BAD_PARAMETER);
659             }
660 
661             Length += ACPI_ROUND_UP_TO_NATIVE_WORD (Size);
662             break;
663 
664         default:
665             /*
666              * No other reference opcodes are supported.
667              * Notably, Locals and Args are not supported, but this may be
668              * required eventually.
669              */
670             ACPI_ERROR ((AE_INFO, "Cannot convert to external object - "
671                 "unsupported Reference Class [%s] 0x%X in object %p",
672                 AcpiUtGetReferenceName (InternalObject),
673                 InternalObject->Reference.Class, InternalObject));
674             Status = AE_TYPE;
675             break;
676         }
677         break;
678 
679     default:
680 
681         ACPI_ERROR ((AE_INFO, "Cannot convert to external object - "
682             "unsupported type [%s] 0x%X in object %p",
683             AcpiUtGetObjectTypeName (InternalObject),
684             InternalObject->Common.Type, InternalObject));
685         Status = AE_TYPE;
686         break;
687     }
688 
689     /*
690      * Account for the space required by the object rounded up to the next
691      * multiple of the machine word size. This keeps each object aligned
692      * on a machine word boundary. (preventing alignment faults on some
693      * machines.)
694      */
695     *ObjLength = ACPI_ROUND_UP_TO_NATIVE_WORD (Length);
696     return_ACPI_STATUS (Status);
697 }
698 
699 
700 /*******************************************************************************
701  *
702  * FUNCTION:    AcpiUtGetElementLength
703  *
704  * PARAMETERS:  ACPI_PKG_CALLBACK
705  *
706  * RETURN:      Status
707  *
708  * DESCRIPTION: Get the length of one package element.
709  *
710  ******************************************************************************/
711 
712 static ACPI_STATUS
713 AcpiUtGetElementLength (
714     UINT8                   ObjectType,
715     ACPI_OPERAND_OBJECT     *SourceObject,
716     ACPI_GENERIC_STATE      *State,
717     void                    *Context)
718 {
719     ACPI_STATUS             Status = AE_OK;
720     ACPI_PKG_INFO           *Info = (ACPI_PKG_INFO *) Context;
721     ACPI_SIZE               ObjectSpace;
722 
723 
724     switch (ObjectType)
725     {
726     case ACPI_COPY_TYPE_SIMPLE:
727         /*
728          * Simple object - just get the size (Null object/entry is handled
729          * here also) and sum it into the running package length
730          */
731         Status = AcpiUtGetSimpleObjectSize (SourceObject, &ObjectSpace);
732         if (ACPI_FAILURE (Status))
733         {
734             return (Status);
735         }
736 
737         Info->Length += ObjectSpace;
738         break;
739 
740     case ACPI_COPY_TYPE_PACKAGE:
741 
742         /* Package object - nothing much to do here, let the walk handle it */
743 
744         Info->NumPackages++;
745         State->Pkg.ThisTargetObj = NULL;
746         break;
747 
748     default:
749 
750         /* No other types allowed */
751 
752         return (AE_BAD_PARAMETER);
753     }
754 
755     return (Status);
756 }
757 
758 
759 /*******************************************************************************
760  *
761  * FUNCTION:    AcpiUtGetPackageObjectSize
762  *
763  * PARAMETERS:  InternalObject      - An ACPI internal object
764  *              ObjLength           - Where the length is returned
765  *
766  * RETURN:      Status
767  *
768  * DESCRIPTION: This function is called to determine the space required to
769  *              contain a package object for return to an external user.
770  *
771  *              This is moderately complex since a package contains other
772  *              objects including packages.
773  *
774  ******************************************************************************/
775 
776 static ACPI_STATUS
777 AcpiUtGetPackageObjectSize (
778     ACPI_OPERAND_OBJECT     *InternalObject,
779     ACPI_SIZE               *ObjLength)
780 {
781     ACPI_STATUS             Status;
782     ACPI_PKG_INFO           Info;
783 
784 
785     ACPI_FUNCTION_TRACE_PTR (UtGetPackageObjectSize, InternalObject);
786 
787 
788     Info.Length      = 0;
789     Info.ObjectSpace = 0;
790     Info.NumPackages = 1;
791 
792     Status = AcpiUtWalkPackageTree (InternalObject, NULL,
793         AcpiUtGetElementLength, &Info);
794     if (ACPI_FAILURE (Status))
795     {
796         return_ACPI_STATUS (Status);
797     }
798 
799     /*
800      * We have handled all of the objects in all levels of the package.
801      * just add the length of the package objects themselves.
802      * Round up to the next machine word.
803      */
804     Info.Length += ACPI_ROUND_UP_TO_NATIVE_WORD (sizeof (ACPI_OBJECT)) *
805                     (ACPI_SIZE) Info.NumPackages;
806 
807     /* Return the total package length */
808 
809     *ObjLength = Info.Length;
810     return_ACPI_STATUS (Status);
811 }
812 
813 
814 /*******************************************************************************
815  *
816  * FUNCTION:    AcpiUtGetObjectSize
817  *
818  * PARAMETERS:  InternalObject      - An ACPI internal object
819  *              ObjLength           - Where the length will be returned
820  *
821  * RETURN:      Status
822  *
823  * DESCRIPTION: This function is called to determine the space required to
824  *              contain an object for return to an API user.
825  *
826  ******************************************************************************/
827 
828 ACPI_STATUS
829 AcpiUtGetObjectSize (
830     ACPI_OPERAND_OBJECT     *InternalObject,
831     ACPI_SIZE               *ObjLength)
832 {
833     ACPI_STATUS             Status;
834 
835 
836     ACPI_FUNCTION_ENTRY ();
837 
838 
839     if ((ACPI_GET_DESCRIPTOR_TYPE (InternalObject) == ACPI_DESC_TYPE_OPERAND) &&
840         (InternalObject->Common.Type == ACPI_TYPE_PACKAGE))
841     {
842         Status = AcpiUtGetPackageObjectSize (InternalObject, ObjLength);
843     }
844     else
845     {
846         Status = AcpiUtGetSimpleObjectSize (InternalObject, ObjLength);
847     }
848 
849     return (Status);
850 }
851