1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
117 #define __DSOBJECT_C__
120 #include "acparser.h"
122 #include "acdispat.h"
123 #include "acnamesp.h"
124 #include "acinterp.h"
126 #define _COMPONENT ACPI_DISPATCHER
127 ACPI_MODULE_NAME ("dsobject")
129 /* Local prototypes */
132 AcpiDsBuildInternalObject (
133 ACPI_WALK_STATE *WalkState,
134 ACPI_PARSE_OBJECT *Op,
135 ACPI_OPERAND_OBJECT **ObjDescPtr);
138 #ifndef ACPI_NO_METHOD_EXECUTION
139 /*******************************************************************************
141 * FUNCTION: AcpiDsBuildInternalObject
143 * PARAMETERS: WalkState - Current walk state
144 * Op - Parser object to be translated
145 * ObjDescPtr - Where the ACPI internal object is returned
149 * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
150 * Simple objects are any objects other than a package object!
152 ******************************************************************************/
155 AcpiDsBuildInternalObject (
156 ACPI_WALK_STATE *WalkState,
157 ACPI_PARSE_OBJECT *Op,
158 ACPI_OPERAND_OBJECT **ObjDescPtr)
160 ACPI_OPERAND_OBJECT *ObjDesc;
164 ACPI_FUNCTION_TRACE (DsBuildInternalObject);
168 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
171 * This is a named object reference. If this name was
172 * previously looked up in the namespace, it was stored in this op.
173 * Otherwise, go ahead and look it up now
175 if (!Op->Common.Node)
177 Status = AcpiNsLookup (WalkState->ScopeInfo,
178 Op->Common.Value.String,
179 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
180 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE, NULL,
181 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, &(Op->Common.Node)));
182 if (ACPI_FAILURE (Status))
184 /* Check if we are resolving a named reference within a package */
186 if ((Status == AE_NOT_FOUND) && (AcpiGbl_EnableInterpreterSlack) &&
188 ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
189 (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP)))
192 * We didn't find the target and we are populating elements
193 * of a package - ignore if slack enabled. Some ASL code
194 * contains dangling invalid references in packages and
195 * expects that no exception will be issued. Leave the
196 * element as a null element. It cannot be used, but it
197 * can be overwritten by subsequent ASL code - this is
198 * typically the case.
200 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
201 "Ignoring unresolved reference in package [%4.4s]\n",
202 WalkState->ScopeInfo->Scope.Node->Name.Ascii));
204 return_ACPI_STATUS (AE_OK);
208 ACPI_ERROR_NAMESPACE (Op->Common.Value.String, Status);
211 return_ACPI_STATUS (Status);
216 /* Create and init a new internal ACPI object */
218 ObjDesc = AcpiUtCreateInternalObject (
219 (AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode))->ObjectType);
222 return_ACPI_STATUS (AE_NO_MEMORY);
225 Status = AcpiDsInitObjectFromOp (WalkState, Op, Op->Common.AmlOpcode,
227 if (ACPI_FAILURE (Status))
229 AcpiUtRemoveReference (ObjDesc);
230 return_ACPI_STATUS (Status);
233 *ObjDescPtr = ObjDesc;
234 return_ACPI_STATUS (AE_OK);
238 /*******************************************************************************
240 * FUNCTION: AcpiDsBuildInternalBufferObj
242 * PARAMETERS: WalkState - Current walk state
243 * Op - Parser object to be translated
244 * BufferLength - Length of the buffer
245 * ObjDescPtr - Where the ACPI internal object is returned
249 * DESCRIPTION: Translate a parser Op package object to the equivalent
252 ******************************************************************************/
255 AcpiDsBuildInternalBufferObj (
256 ACPI_WALK_STATE *WalkState,
257 ACPI_PARSE_OBJECT *Op,
259 ACPI_OPERAND_OBJECT **ObjDescPtr)
261 ACPI_PARSE_OBJECT *Arg;
262 ACPI_OPERAND_OBJECT *ObjDesc;
263 ACPI_PARSE_OBJECT *ByteList;
264 UINT32 ByteListLength = 0;
267 ACPI_FUNCTION_TRACE (DsBuildInternalBufferObj);
271 * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
272 * The buffer object already exists (from the NS node), otherwise it must
275 ObjDesc = *ObjDescPtr;
278 /* Create a new buffer object */
280 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
281 *ObjDescPtr = ObjDesc;
284 return_ACPI_STATUS (AE_NO_MEMORY);
289 * Second arg is the buffer data (optional) ByteList can be either
290 * individual bytes or a string initializer. In either case, a
291 * ByteList appears in the AML.
293 Arg = Op->Common.Value.Arg; /* skip first arg */
295 ByteList = Arg->Named.Next;
298 if (ByteList->Common.AmlOpcode != AML_INT_BYTELIST_OP)
300 ACPI_ERROR ((AE_INFO,
301 "Expecting bytelist, got AML opcode %X in op %p",
302 ByteList->Common.AmlOpcode, ByteList));
304 AcpiUtRemoveReference (ObjDesc);
308 ByteListLength = (UINT32) ByteList->Common.Value.Integer;
312 * The buffer length (number of bytes) will be the larger of:
313 * 1) The specified buffer length and
314 * 2) The length of the initializer byte list
316 ObjDesc->Buffer.Length = BufferLength;
317 if (ByteListLength > BufferLength)
319 ObjDesc->Buffer.Length = ByteListLength;
322 /* Allocate the buffer */
324 if (ObjDesc->Buffer.Length == 0)
326 ObjDesc->Buffer.Pointer = NULL;
327 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
328 "Buffer defined with zero length in AML, creating\n"));
332 ObjDesc->Buffer.Pointer = ACPI_ALLOCATE_ZEROED (
333 ObjDesc->Buffer.Length);
334 if (!ObjDesc->Buffer.Pointer)
336 AcpiUtDeleteObjectDesc (ObjDesc);
337 return_ACPI_STATUS (AE_NO_MEMORY);
340 /* Initialize buffer from the ByteList (if present) */
344 ACPI_MEMCPY (ObjDesc->Buffer.Pointer, ByteList->Named.Data,
349 ObjDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
350 Op->Common.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjDesc);
351 return_ACPI_STATUS (AE_OK);
355 /*******************************************************************************
357 * FUNCTION: AcpiDsBuildInternalPackageObj
359 * PARAMETERS: WalkState - Current walk state
360 * Op - Parser object to be translated
361 * ElementCount - Number of elements in the package - this is
362 * the NumElements argument to Package()
363 * ObjDescPtr - Where the ACPI internal object is returned
367 * DESCRIPTION: Translate a parser Op package object to the equivalent
370 * NOTE: The number of elements in the package will be always be the NumElements
371 * count, regardless of the number of elements in the package list. If
372 * NumElements is smaller, only that many package list elements are used.
373 * if NumElements is larger, the Package object is padded out with
374 * objects of type Uninitialized (as per ACPI spec.)
376 * Even though the ASL compilers do not allow NumElements to be smaller
377 * than the Package list length (for the fixed length package opcode), some
378 * BIOS code modifies the AML on the fly to adjust the NumElements, and
379 * this code compensates for that. This also provides compatibility with
380 * other AML interpreters.
382 ******************************************************************************/
385 AcpiDsBuildInternalPackageObj (
386 ACPI_WALK_STATE *WalkState,
387 ACPI_PARSE_OBJECT *Op,
389 ACPI_OPERAND_OBJECT **ObjDescPtr)
391 ACPI_PARSE_OBJECT *Arg;
392 ACPI_PARSE_OBJECT *Parent;
393 ACPI_OPERAND_OBJECT *ObjDesc = NULL;
394 ACPI_STATUS Status = AE_OK;
398 ACPI_FUNCTION_TRACE (DsBuildInternalPackageObj);
401 /* Find the parent of a possibly nested package */
403 Parent = Op->Common.Parent;
404 while ((Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
405 (Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
407 Parent = Parent->Common.Parent;
411 * If we are evaluating a Named package object "Name (xxxx, Package)",
412 * the package object already exists, otherwise it must be created.
414 ObjDesc = *ObjDescPtr;
417 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PACKAGE);
418 *ObjDescPtr = ObjDesc;
421 return_ACPI_STATUS (AE_NO_MEMORY);
424 ObjDesc->Package.Node = Parent->Common.Node;
428 * Allocate the element array (array of pointers to the individual
429 * objects) based on the NumElements parameter. Add an extra pointer slot
430 * so that the list is always null terminated.
432 ObjDesc->Package.Elements = ACPI_ALLOCATE_ZEROED (
433 ((ACPI_SIZE) ElementCount + 1) * sizeof (void *));
435 if (!ObjDesc->Package.Elements)
437 AcpiUtDeleteObjectDesc (ObjDesc);
438 return_ACPI_STATUS (AE_NO_MEMORY);
441 ObjDesc->Package.Count = ElementCount;
444 * Initialize the elements of the package, up to the NumElements count.
445 * Package is automatically padded with uninitialized (NULL) elements
446 * if NumElements is greater than the package list length. Likewise,
447 * Package is truncated if NumElements is less than the list length.
449 Arg = Op->Common.Value.Arg;
450 Arg = Arg->Common.Next;
451 for (i = 0; Arg && (i < ElementCount); i++)
453 if (Arg->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
455 /* This package element is already built, just get it */
457 ObjDesc->Package.Elements[i] =
458 ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Arg->Common.Node);
462 Status = AcpiDsBuildInternalObject (WalkState, Arg,
463 &ObjDesc->Package.Elements[i]);
465 Arg = Arg->Common.Next;
470 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
471 "Package List length larger than NumElements count (%X), truncated\n",
475 ObjDesc->Package.Flags |= AOPOBJ_DATA_VALID;
476 Op->Common.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjDesc);
477 return_ACPI_STATUS (Status);
481 /*******************************************************************************
483 * FUNCTION: AcpiDsCreateNode
485 * PARAMETERS: WalkState - Current walk state
486 * Node - NS Node to be initialized
487 * Op - Parser object to be translated
491 * DESCRIPTION: Create the object to be associated with a namespace node
493 ******************************************************************************/
497 ACPI_WALK_STATE *WalkState,
498 ACPI_NAMESPACE_NODE *Node,
499 ACPI_PARSE_OBJECT *Op)
502 ACPI_OPERAND_OBJECT *ObjDesc;
505 ACPI_FUNCTION_TRACE_PTR (DsCreateNode, Op);
509 * Because of the execution pass through the non-control-method
510 * parts of the table, we can arrive here twice. Only init
511 * the named object node the first time through
513 if (AcpiNsGetAttachedObject (Node))
515 return_ACPI_STATUS (AE_OK);
518 if (!Op->Common.Value.Arg)
520 /* No arguments, there is nothing to do */
522 return_ACPI_STATUS (AE_OK);
525 /* Build an internal object for the argument(s) */
527 Status = AcpiDsBuildInternalObject (WalkState, Op->Common.Value.Arg,
529 if (ACPI_FAILURE (Status))
531 return_ACPI_STATUS (Status);
534 /* Re-type the object according to its argument */
536 Node->Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
538 /* Attach obj to node */
540 Status = AcpiNsAttachObject (Node, ObjDesc, Node->Type);
542 /* Remove local reference to the object */
544 AcpiUtRemoveReference (ObjDesc);
545 return_ACPI_STATUS (Status);
548 #endif /* ACPI_NO_METHOD_EXECUTION */
551 /*******************************************************************************
553 * FUNCTION: AcpiDsInitObjectFromOp
555 * PARAMETERS: WalkState - Current walk state
556 * Op - Parser op used to init the internal object
557 * Opcode - AML opcode associated with the object
558 * RetObjDesc - Namespace object to be initialized
562 * DESCRIPTION: Initialize a namespace object from a parser Op and its
563 * associated arguments. The namespace object is a more compact
564 * representation of the Op and its arguments.
566 ******************************************************************************/
569 AcpiDsInitObjectFromOp (
570 ACPI_WALK_STATE *WalkState,
571 ACPI_PARSE_OBJECT *Op,
573 ACPI_OPERAND_OBJECT **RetObjDesc)
575 const ACPI_OPCODE_INFO *OpInfo;
576 ACPI_OPERAND_OBJECT *ObjDesc;
577 ACPI_STATUS Status = AE_OK;
580 ACPI_FUNCTION_TRACE (DsInitObjectFromOp);
583 ObjDesc = *RetObjDesc;
584 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
585 if (OpInfo->Class == AML_CLASS_UNKNOWN)
589 return_ACPI_STATUS (AE_TYPE);
592 /* Perform per-object initialization */
594 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
596 case ACPI_TYPE_BUFFER:
599 * Defer evaluation of Buffer TermArg operand
601 ObjDesc->Buffer.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE,
602 WalkState->Operands[0]);
603 ObjDesc->Buffer.AmlStart = Op->Named.Data;
604 ObjDesc->Buffer.AmlLength = Op->Named.Length;
608 case ACPI_TYPE_PACKAGE:
611 * Defer evaluation of Package TermArg operand
613 ObjDesc->Package.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE,
614 WalkState->Operands[0]);
615 ObjDesc->Package.AmlStart = Op->Named.Data;
616 ObjDesc->Package.AmlLength = Op->Named.Length;
620 case ACPI_TYPE_INTEGER:
622 switch (OpInfo->Type)
624 case AML_TYPE_CONSTANT:
626 * Resolve AML Constants here - AND ONLY HERE!
627 * All constants are integers.
628 * We mark the integer with a flag that indicates that it started
629 * life as a constant -- so that stores to constants will perform
630 * as expected (noop). ZeroOp is used as a placeholder for optional
633 ObjDesc->Common.Flags = AOPOBJ_AML_CONSTANT;
639 ObjDesc->Integer.Value = 0;
644 ObjDesc->Integer.Value = 1;
649 ObjDesc->Integer.Value = ACPI_INTEGER_MAX;
651 /* Truncate value if we are executing from a 32-bit ACPI table */
653 #ifndef ACPI_NO_METHOD_EXECUTION
654 AcpiExTruncateFor32bitTable (ObjDesc);
658 case AML_REVISION_OP:
660 ObjDesc->Integer.Value = ACPI_CA_VERSION;
665 ACPI_ERROR ((AE_INFO,
666 "Unknown constant opcode %X", Opcode));
667 Status = AE_AML_OPERAND_TYPE;
673 case AML_TYPE_LITERAL:
675 ObjDesc->Integer.Value = Op->Common.Value.Integer;
676 #ifndef ACPI_NO_METHOD_EXECUTION
677 AcpiExTruncateFor32bitTable (ObjDesc);
683 ACPI_ERROR ((AE_INFO, "Unknown Integer type %X",
685 Status = AE_AML_OPERAND_TYPE;
691 case ACPI_TYPE_STRING:
693 ObjDesc->String.Pointer = Op->Common.Value.String;
694 ObjDesc->String.Length = (UINT32) ACPI_STRLEN (Op->Common.Value.String);
697 * The string is contained in the ACPI table, don't ever try
700 ObjDesc->Common.Flags |= AOPOBJ_STATIC_POINTER;
704 case ACPI_TYPE_METHOD:
708 case ACPI_TYPE_LOCAL_REFERENCE:
710 switch (OpInfo->Type)
712 case AML_TYPE_LOCAL_VARIABLE:
714 /* Split the opcode into a base opcode + offset */
716 ObjDesc->Reference.Opcode = AML_LOCAL_OP;
717 ObjDesc->Reference.Offset = Opcode - AML_LOCAL_OP;
719 #ifndef ACPI_NO_METHOD_EXECUTION
720 Status = AcpiDsMethodDataGetNode (AML_LOCAL_OP,
721 ObjDesc->Reference.Offset,
723 (ACPI_NAMESPACE_NODE **) &ObjDesc->Reference.Object);
728 case AML_TYPE_METHOD_ARGUMENT:
730 /* Split the opcode into a base opcode + offset */
732 ObjDesc->Reference.Opcode = AML_ARG_OP;
733 ObjDesc->Reference.Offset = Opcode - AML_ARG_OP;
735 #ifndef ACPI_NO_METHOD_EXECUTION
736 Status = AcpiDsMethodDataGetNode (AML_ARG_OP,
737 ObjDesc->Reference.Offset,
739 (ACPI_NAMESPACE_NODE **) &ObjDesc->Reference.Object);
743 default: /* Other literals, etc.. */
745 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
747 /* Node was saved in Op */
749 ObjDesc->Reference.Node = Op->Common.Node;
752 ObjDesc->Reference.Opcode = Opcode;
760 ACPI_ERROR ((AE_INFO, "Unimplemented data type: %X",
761 ACPI_GET_OBJECT_TYPE (ObjDesc)));
763 Status = AE_AML_OPERAND_TYPE;
767 return_ACPI_STATUS (Status);