1 /******************************************************************************
3 * Module Name: utobject - ACPI object create/delete/size/cache routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #define __UTOBJECT_C__
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <contrib/dev/acpica/include/accommon.h>
48 #include <contrib/dev/acpica/include/acnamesp.h>
51 #define _COMPONENT ACPI_UTILITIES
52 ACPI_MODULE_NAME ("utobject")
54 /* Local prototypes */
57 AcpiUtGetSimpleObjectSize (
58 ACPI_OPERAND_OBJECT *Obj,
59 ACPI_SIZE *ObjLength);
62 AcpiUtGetPackageObjectSize (
63 ACPI_OPERAND_OBJECT *Obj,
64 ACPI_SIZE *ObjLength);
67 AcpiUtGetElementLength (
69 ACPI_OPERAND_OBJECT *SourceObject,
70 ACPI_GENERIC_STATE *State,
74 /*******************************************************************************
76 * FUNCTION: AcpiUtCreateInternalObjectDbg
78 * PARAMETERS: ModuleName - Source file name of caller
79 * LineNumber - Line number of caller
80 * ComponentId - Component type of caller
81 * Type - ACPI Type of the new object
83 * RETURN: A new internal object, null on failure
85 * DESCRIPTION: Create and initialize a new internal object.
87 * NOTE: We always allocate the worst-case object descriptor because
88 * these objects are cached, and we want them to be
89 * one-size-satisifies-any-request. This in itself may not be
90 * the most memory efficient, but the efficiency of the object
91 * cache should more than make up for this!
93 ******************************************************************************/
96 AcpiUtCreateInternalObjectDbg (
97 const char *ModuleName,
100 ACPI_OBJECT_TYPE Type)
102 ACPI_OPERAND_OBJECT *Object;
103 ACPI_OPERAND_OBJECT *SecondObject;
106 ACPI_FUNCTION_TRACE_STR (UtCreateInternalObjectDbg,
107 AcpiUtGetTypeName (Type));
110 /* Allocate the raw object descriptor */
112 Object = AcpiUtAllocateObjectDescDbg (ModuleName, LineNumber, ComponentId);
120 case ACPI_TYPE_REGION:
121 case ACPI_TYPE_BUFFER_FIELD:
122 case ACPI_TYPE_LOCAL_BANK_FIELD:
124 /* These types require a secondary object */
126 SecondObject = AcpiUtAllocateObjectDescDbg (ModuleName,
127 LineNumber, ComponentId);
130 AcpiUtDeleteObjectDesc (Object);
134 SecondObject->Common.Type = ACPI_TYPE_LOCAL_EXTRA;
135 SecondObject->Common.ReferenceCount = 1;
137 /* Link the second object to the first */
139 Object->Common.NextObject = SecondObject;
143 /* All others have no secondary object */
147 /* Save the object type in the object descriptor */
149 Object->Common.Type = (UINT8) Type;
151 /* Init the reference count */
153 Object->Common.ReferenceCount = 1;
155 /* Any per-type initialization should go here */
161 /*******************************************************************************
163 * FUNCTION: AcpiUtCreatePackageObject
165 * PARAMETERS: Count - Number of package elements
167 * RETURN: Pointer to a new Package object, null on failure
169 * DESCRIPTION: Create a fully initialized package object
171 ******************************************************************************/
173 ACPI_OPERAND_OBJECT *
174 AcpiUtCreatePackageObject (
177 ACPI_OPERAND_OBJECT *PackageDesc;
178 ACPI_OPERAND_OBJECT **PackageElements;
181 ACPI_FUNCTION_TRACE_U32 (UtCreatePackageObject, Count);
184 /* Create a new Package object */
186 PackageDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PACKAGE);
193 * Create the element array. Count+1 allows the array to be null
196 PackageElements = ACPI_ALLOCATE_ZEROED (
197 ((ACPI_SIZE) Count + 1) * sizeof (void *));
198 if (!PackageElements)
200 ACPI_FREE (PackageDesc);
204 PackageDesc->Package.Count = Count;
205 PackageDesc->Package.Elements = PackageElements;
206 return_PTR (PackageDesc);
210 /*******************************************************************************
212 * FUNCTION: AcpiUtCreateIntegerObject
214 * PARAMETERS: InitialValue - Initial value for the integer
216 * RETURN: Pointer to a new Integer object, null on failure
218 * DESCRIPTION: Create an initialized integer object
220 ******************************************************************************/
222 ACPI_OPERAND_OBJECT *
223 AcpiUtCreateIntegerObject (
226 ACPI_OPERAND_OBJECT *IntegerDesc;
229 ACPI_FUNCTION_TRACE (UtCreateIntegerObject);
232 /* Create and initialize a new integer object */
234 IntegerDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
240 IntegerDesc->Integer.Value = InitialValue;
241 return_PTR (IntegerDesc);
245 /*******************************************************************************
247 * FUNCTION: AcpiUtCreateBufferObject
249 * PARAMETERS: BufferSize - Size of buffer to be created
251 * RETURN: Pointer to a new Buffer object, null on failure
253 * DESCRIPTION: Create a fully initialized buffer object
255 ******************************************************************************/
257 ACPI_OPERAND_OBJECT *
258 AcpiUtCreateBufferObject (
259 ACPI_SIZE BufferSize)
261 ACPI_OPERAND_OBJECT *BufferDesc;
262 UINT8 *Buffer = NULL;
265 ACPI_FUNCTION_TRACE_U32 (UtCreateBufferObject, BufferSize);
268 /* Create a new Buffer object */
270 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
276 /* Create an actual buffer only if size > 0 */
280 /* Allocate the actual buffer */
282 Buffer = ACPI_ALLOCATE_ZEROED (BufferSize);
285 ACPI_ERROR ((AE_INFO, "Could not allocate size %u",
286 (UINT32) BufferSize));
287 AcpiUtRemoveReference (BufferDesc);
292 /* Complete buffer object initialization */
294 BufferDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
295 BufferDesc->Buffer.Pointer = Buffer;
296 BufferDesc->Buffer.Length = (UINT32) BufferSize;
298 /* Return the new buffer descriptor */
300 return_PTR (BufferDesc);
304 /*******************************************************************************
306 * FUNCTION: AcpiUtCreateStringObject
308 * PARAMETERS: StringSize - Size of string to be created. Does not
309 * include NULL terminator, this is added
312 * RETURN: Pointer to a new String object
314 * DESCRIPTION: Create a fully initialized string object
316 ******************************************************************************/
318 ACPI_OPERAND_OBJECT *
319 AcpiUtCreateStringObject (
320 ACPI_SIZE StringSize)
322 ACPI_OPERAND_OBJECT *StringDesc;
326 ACPI_FUNCTION_TRACE_U32 (UtCreateStringObject, StringSize);
329 /* Create a new String object */
331 StringDesc = AcpiUtCreateInternalObject (ACPI_TYPE_STRING);
338 * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
339 * NOTE: Zero-length strings are NULL terminated
341 String = ACPI_ALLOCATE_ZEROED (StringSize + 1);
344 ACPI_ERROR ((AE_INFO, "Could not allocate size %u",
345 (UINT32) StringSize));
346 AcpiUtRemoveReference (StringDesc);
350 /* Complete string object initialization */
352 StringDesc->String.Pointer = String;
353 StringDesc->String.Length = (UINT32) StringSize;
355 /* Return the new string descriptor */
357 return_PTR (StringDesc);
361 /*******************************************************************************
363 * FUNCTION: AcpiUtValidInternalObject
365 * PARAMETERS: Object - Object to be validated
367 * RETURN: TRUE if object is valid, FALSE otherwise
369 * DESCRIPTION: Validate a pointer to be an ACPI_OPERAND_OBJECT
371 ******************************************************************************/
374 AcpiUtValidInternalObject (
378 ACPI_FUNCTION_NAME (UtValidInternalObject);
381 /* Check for a null pointer */
385 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "**** Null Object Ptr\n"));
389 /* Check the descriptor type field */
391 switch (ACPI_GET_DESCRIPTOR_TYPE (Object))
393 case ACPI_DESC_TYPE_OPERAND:
395 /* The object appears to be a valid ACPI_OPERAND_OBJECT */
400 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
401 "%p is not not an ACPI operand obj [%s]\n",
402 Object, AcpiUtGetDescriptorName (Object)));
410 /*******************************************************************************
412 * FUNCTION: AcpiUtAllocateObjectDescDbg
414 * PARAMETERS: ModuleName - Caller's module name (for error output)
415 * LineNumber - Caller's line number (for error output)
416 * ComponentId - Caller's component ID (for error output)
418 * RETURN: Pointer to newly allocated object descriptor. Null on error
420 * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
423 ******************************************************************************/
426 AcpiUtAllocateObjectDescDbg (
427 const char *ModuleName,
431 ACPI_OPERAND_OBJECT *Object;
434 ACPI_FUNCTION_TRACE (UtAllocateObjectDescDbg);
437 Object = AcpiOsAcquireObject (AcpiGbl_OperandCache);
440 ACPI_ERROR ((ModuleName, LineNumber,
441 "Could not allocate an object descriptor"));
446 /* Mark the descriptor type */
448 ACPI_SET_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_OPERAND);
450 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
451 Object, (UINT32) sizeof (ACPI_OPERAND_OBJECT)));
457 /*******************************************************************************
459 * FUNCTION: AcpiUtDeleteObjectDesc
461 * PARAMETERS: Object - An Acpi internal object to be deleted
465 * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
467 ******************************************************************************/
470 AcpiUtDeleteObjectDesc (
471 ACPI_OPERAND_OBJECT *Object)
473 ACPI_FUNCTION_TRACE_PTR (UtDeleteObjectDesc, Object);
476 /* Object must be an ACPI_OPERAND_OBJECT */
478 if (ACPI_GET_DESCRIPTOR_TYPE (Object) != ACPI_DESC_TYPE_OPERAND)
480 ACPI_ERROR ((AE_INFO,
481 "%p is not an ACPI Operand object [%s]", Object,
482 AcpiUtGetDescriptorName (Object)));
486 (void) AcpiOsReleaseObject (AcpiGbl_OperandCache, Object);
491 /*******************************************************************************
493 * FUNCTION: AcpiUtGetSimpleObjectSize
495 * PARAMETERS: InternalObject - An ACPI operand object
496 * ObjLength - Where the length is returned
500 * DESCRIPTION: This function is called to determine the space required to
501 * contain a simple object for return to an external user.
503 * The length includes the object structure plus any additional
506 ******************************************************************************/
509 AcpiUtGetSimpleObjectSize (
510 ACPI_OPERAND_OBJECT *InternalObject,
511 ACPI_SIZE *ObjLength)
515 ACPI_STATUS Status = AE_OK;
518 ACPI_FUNCTION_TRACE_PTR (UtGetSimpleObjectSize, InternalObject);
521 /* Start with the length of the (external) Acpi object */
523 Length = sizeof (ACPI_OBJECT);
525 /* A NULL object is allowed, can be a legal uninitialized package element */
530 * Object is NULL, just return the length of ACPI_OBJECT
531 * (A NULL ACPI_OBJECT is an object of all zeroes.)
533 *ObjLength = ACPI_ROUND_UP_TO_NATIVE_WORD (Length);
534 return_ACPI_STATUS (AE_OK);
537 /* A Namespace Node should never appear here */
539 if (ACPI_GET_DESCRIPTOR_TYPE (InternalObject) == ACPI_DESC_TYPE_NAMED)
541 /* A namespace node should never get here */
543 return_ACPI_STATUS (AE_AML_INTERNAL);
547 * The final length depends on the object type
548 * Strings and Buffers are packed right up against the parent object and
549 * must be accessed bytewise or there may be alignment problems on
552 switch (InternalObject->Common.Type)
554 case ACPI_TYPE_STRING:
556 Length += (ACPI_SIZE) InternalObject->String.Length + 1;
560 case ACPI_TYPE_BUFFER:
562 Length += (ACPI_SIZE) InternalObject->Buffer.Length;
566 case ACPI_TYPE_INTEGER:
567 case ACPI_TYPE_PROCESSOR:
568 case ACPI_TYPE_POWER:
570 /* No extra data for these types */
575 case ACPI_TYPE_LOCAL_REFERENCE:
577 switch (InternalObject->Reference.Class)
579 case ACPI_REFCLASS_NAME:
582 * Get the actual length of the full pathname to this object.
583 * The reference will be converted to the pathname to the object
585 Size = AcpiNsGetPathnameLength (InternalObject->Reference.Node);
588 return_ACPI_STATUS (AE_BAD_PARAMETER);
591 Length += ACPI_ROUND_UP_TO_NATIVE_WORD (Size);
597 * No other reference opcodes are supported.
598 * Notably, Locals and Args are not supported, but this may be
599 * required eventually.
601 ACPI_ERROR ((AE_INFO, "Cannot convert to external object - "
602 "unsupported Reference Class [%s] 0x%X in object %p",
603 AcpiUtGetReferenceName (InternalObject),
604 InternalObject->Reference.Class, InternalObject));
613 ACPI_ERROR ((AE_INFO, "Cannot convert to external object - "
614 "unsupported type [%s] 0x%X in object %p",
615 AcpiUtGetObjectTypeName (InternalObject),
616 InternalObject->Common.Type, InternalObject));
622 * Account for the space required by the object rounded up to the next
623 * multiple of the machine word size. This keeps each object aligned
624 * on a machine word boundary. (preventing alignment faults on some
627 *ObjLength = ACPI_ROUND_UP_TO_NATIVE_WORD (Length);
628 return_ACPI_STATUS (Status);
632 /*******************************************************************************
634 * FUNCTION: AcpiUtGetElementLength
636 * PARAMETERS: ACPI_PKG_CALLBACK
640 * DESCRIPTION: Get the length of one package element.
642 ******************************************************************************/
645 AcpiUtGetElementLength (
647 ACPI_OPERAND_OBJECT *SourceObject,
648 ACPI_GENERIC_STATE *State,
651 ACPI_STATUS Status = AE_OK;
652 ACPI_PKG_INFO *Info = (ACPI_PKG_INFO *) Context;
653 ACPI_SIZE ObjectSpace;
658 case ACPI_COPY_TYPE_SIMPLE:
661 * Simple object - just get the size (Null object/entry is handled
662 * here also) and sum it into the running package length
664 Status = AcpiUtGetSimpleObjectSize (SourceObject, &ObjectSpace);
665 if (ACPI_FAILURE (Status))
670 Info->Length += ObjectSpace;
674 case ACPI_COPY_TYPE_PACKAGE:
676 /* Package object - nothing much to do here, let the walk handle it */
679 State->Pkg.ThisTargetObj = NULL;
685 /* No other types allowed */
687 return (AE_BAD_PARAMETER);
694 /*******************************************************************************
696 * FUNCTION: AcpiUtGetPackageObjectSize
698 * PARAMETERS: InternalObject - An ACPI internal object
699 * ObjLength - Where the length is returned
703 * DESCRIPTION: This function is called to determine the space required to
704 * contain a package object for return to an external user.
706 * This is moderately complex since a package contains other
707 * objects including packages.
709 ******************************************************************************/
712 AcpiUtGetPackageObjectSize (
713 ACPI_OPERAND_OBJECT *InternalObject,
714 ACPI_SIZE *ObjLength)
720 ACPI_FUNCTION_TRACE_PTR (UtGetPackageObjectSize, InternalObject);
724 Info.ObjectSpace = 0;
725 Info.NumPackages = 1;
727 Status = AcpiUtWalkPackageTree (InternalObject, NULL,
728 AcpiUtGetElementLength, &Info);
729 if (ACPI_FAILURE (Status))
731 return_ACPI_STATUS (Status);
735 * We have handled all of the objects in all levels of the package.
736 * just add the length of the package objects themselves.
737 * Round up to the next machine word.
739 Info.Length += ACPI_ROUND_UP_TO_NATIVE_WORD (sizeof (ACPI_OBJECT)) *
740 (ACPI_SIZE) Info.NumPackages;
742 /* Return the total package length */
744 *ObjLength = Info.Length;
745 return_ACPI_STATUS (Status);
749 /*******************************************************************************
751 * FUNCTION: AcpiUtGetObjectSize
753 * PARAMETERS: InternalObject - An ACPI internal object
754 * ObjLength - Where the length will be returned
758 * DESCRIPTION: This function is called to determine the space required to
759 * contain an object for return to an API user.
761 ******************************************************************************/
764 AcpiUtGetObjectSize (
765 ACPI_OPERAND_OBJECT *InternalObject,
766 ACPI_SIZE *ObjLength)
771 ACPI_FUNCTION_ENTRY ();
774 if ((ACPI_GET_DESCRIPTOR_TYPE (InternalObject) == ACPI_DESC_TYPE_OPERAND) &&
775 (InternalObject->Common.Type == ACPI_TYPE_PACKAGE))
777 Status = AcpiUtGetPackageObjectSize (InternalObject, ObjLength);
781 Status = AcpiUtGetSimpleObjectSize (InternalObject, ObjLength);