1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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")
130 #ifndef ACPI_NO_METHOD_EXECUTION
131 /*****************************************************************************
133 * FUNCTION: AcpiDsBuildInternalObject
135 * PARAMETERS: WalkState - Current walk state
136 * Op - Parser object to be translated
137 * ObjDescPtr - Where the ACPI internal object is returned
141 * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
142 * Simple objects are any objects other than a package object!
144 ****************************************************************************/
147 AcpiDsBuildInternalObject (
148 ACPI_WALK_STATE
*WalkState
,
149 ACPI_PARSE_OBJECT
*Op
,
150 ACPI_OPERAND_OBJECT
**ObjDescPtr
)
152 ACPI_OPERAND_OBJECT
*ObjDesc
;
156 ACPI_FUNCTION_TRACE ("DsBuildInternalObject");
160 if (Op
->Common
.AmlOpcode
== AML_INT_NAMEPATH_OP
)
163 * This is an named object reference. If this name was
164 * previously looked up in the namespace, it was stored in this op.
165 * Otherwise, go ahead and look it up now
167 if (!Op
->Common
.Node
)
169 Status
= AcpiNsLookup (WalkState
->ScopeInfo
, Op
->Common
.Value
.String
,
170 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
171 ACPI_NS_SEARCH_PARENT
| ACPI_NS_DONT_OPEN_SCOPE
, NULL
,
172 (ACPI_NAMESPACE_NODE
**) &(Op
->Common
.Node
));
174 if (ACPI_FAILURE (Status
))
176 ACPI_REPORT_NSERROR (Op
->Common
.Value
.String
, Status
);
177 return_ACPI_STATUS (Status
);
182 /* Create and init the internal ACPI object */
184 ObjDesc
= AcpiUtCreateInternalObject ((AcpiPsGetOpcodeInfo (Op
->Common
.AmlOpcode
))->ObjectType
);
187 return_ACPI_STATUS (AE_NO_MEMORY
);
190 Status
= AcpiDsInitObjectFromOp (WalkState
, Op
, Op
->Common
.AmlOpcode
, &ObjDesc
);
191 if (ACPI_FAILURE (Status
))
193 AcpiUtRemoveReference (ObjDesc
);
194 return_ACPI_STATUS (Status
);
197 *ObjDescPtr
= ObjDesc
;
198 return_ACPI_STATUS (AE_OK
);
202 /*****************************************************************************
204 * FUNCTION: AcpiDsBuildInternalBufferObj
206 * PARAMETERS: WalkState - Current walk state
207 * Op - Parser object to be translated
208 * BufferLength - Length of the buffer
209 * ObjDescPtr - Where the ACPI internal object is returned
213 * DESCRIPTION: Translate a parser Op package object to the equivalent
216 ****************************************************************************/
219 AcpiDsBuildInternalBufferObj (
220 ACPI_WALK_STATE
*WalkState
,
221 ACPI_PARSE_OBJECT
*Op
,
223 ACPI_OPERAND_OBJECT
**ObjDescPtr
)
225 ACPI_PARSE_OBJECT
*Arg
;
226 ACPI_OPERAND_OBJECT
*ObjDesc
;
227 ACPI_PARSE_OBJECT
*ByteList
;
228 UINT32 ByteListLength
= 0;
231 ACPI_FUNCTION_TRACE ("DsBuildInternalBufferObj");
234 ObjDesc
= *ObjDescPtr
;
238 * We are evaluating a Named buffer object "Name (xxxx, Buffer)".
239 * The buffer object already exists (from the NS node)
244 /* Create a new buffer object */
246 ObjDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER
);
247 *ObjDescPtr
= ObjDesc
;
250 return_ACPI_STATUS (AE_NO_MEMORY
);
255 * Second arg is the buffer data (optional) ByteList can be either
256 * individual bytes or a string initializer. In either case, a
257 * ByteList appears in the AML.
259 Arg
= Op
->Common
.Value
.Arg
; /* skip first arg */
261 ByteList
= Arg
->Named
.Next
;
264 if (ByteList
->Common
.AmlOpcode
!= AML_INT_BYTELIST_OP
)
266 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
267 "Expecting bytelist, got AML opcode %X in op %p\n",
268 ByteList
->Common
.AmlOpcode
, ByteList
));
270 AcpiUtRemoveReference (ObjDesc
);
274 ByteListLength
= (UINT32
) ByteList
->Common
.Value
.Integer
;
278 * The buffer length (number of bytes) will be the larger of:
279 * 1) The specified buffer length and
280 * 2) The length of the initializer byte list
282 ObjDesc
->Buffer
.Length
= BufferLength
;
283 if (ByteListLength
> BufferLength
)
285 ObjDesc
->Buffer
.Length
= ByteListLength
;
288 /* Allocate the buffer */
290 if (ObjDesc
->Buffer
.Length
== 0)
292 ObjDesc
->Buffer
.Pointer
= NULL
;
293 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
294 "Buffer defined with zero length in AML, creating\n"));
298 ObjDesc
->Buffer
.Pointer
= ACPI_MEM_CALLOCATE (
299 ObjDesc
->Buffer
.Length
);
300 if (!ObjDesc
->Buffer
.Pointer
)
302 AcpiUtDeleteObjectDesc (ObjDesc
);
303 return_ACPI_STATUS (AE_NO_MEMORY
);
306 /* Initialize buffer from the ByteList (if present) */
310 ACPI_MEMCPY (ObjDesc
->Buffer
.Pointer
, ByteList
->Named
.Data
,
315 ObjDesc
->Buffer
.Flags
|= AOPOBJ_DATA_VALID
;
316 Op
->Common
.Node
= (ACPI_NAMESPACE_NODE
*) ObjDesc
;
317 return_ACPI_STATUS (AE_OK
);
321 /*****************************************************************************
323 * FUNCTION: AcpiDsBuildInternalPackageObj
325 * PARAMETERS: WalkState - Current walk state
326 * Op - Parser object to be translated
327 * PackageLength - Number of elements in the package
328 * ObjDescPtr - Where the ACPI internal object is returned
332 * DESCRIPTION: Translate a parser Op package object to the equivalent
335 ****************************************************************************/
338 AcpiDsBuildInternalPackageObj (
339 ACPI_WALK_STATE
*WalkState
,
340 ACPI_PARSE_OBJECT
*Op
,
341 UINT32 PackageLength
,
342 ACPI_OPERAND_OBJECT
**ObjDescPtr
)
344 ACPI_PARSE_OBJECT
*Arg
;
345 ACPI_PARSE_OBJECT
*Parent
;
346 ACPI_OPERAND_OBJECT
*ObjDesc
= NULL
;
347 UINT32 PackageListLength
;
348 ACPI_STATUS Status
= AE_OK
;
352 ACPI_FUNCTION_TRACE ("DsBuildInternalPackageObj");
355 /* Find the parent of a possibly nested package */
357 Parent
= Op
->Common
.Parent
;
358 while ((Parent
->Common
.AmlOpcode
== AML_PACKAGE_OP
) ||
359 (Parent
->Common
.AmlOpcode
== AML_VAR_PACKAGE_OP
))
361 Parent
= Parent
->Common
.Parent
;
364 ObjDesc
= *ObjDescPtr
;
368 * We are evaluating a Named package object "Name (xxxx, Package)".
369 * Get the existing package object from the NS node
374 ObjDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_PACKAGE
);
375 *ObjDescPtr
= ObjDesc
;
378 return_ACPI_STATUS (AE_NO_MEMORY
);
381 ObjDesc
->Package
.Node
= Parent
->Common
.Node
;
384 ObjDesc
->Package
.Count
= PackageLength
;
386 /* Count the number of items in the package list */
388 PackageListLength
= 0;
389 Arg
= Op
->Common
.Value
.Arg
;
390 Arg
= Arg
->Common
.Next
;
394 Arg
= Arg
->Common
.Next
;
398 * The package length (number of elements) will be the greater
399 * of the specified length and the length of the initializer list
401 if (PackageListLength
> PackageLength
)
403 ObjDesc
->Package
.Count
= PackageListLength
;
407 * Allocate the pointer array (array of pointers to the
408 * individual objects). Add an extra pointer slot so
409 * that the list is always null terminated.
411 ObjDesc
->Package
.Elements
= ACPI_MEM_CALLOCATE (
412 ((ACPI_SIZE
) ObjDesc
->Package
.Count
+ 1) * sizeof (void *));
414 if (!ObjDesc
->Package
.Elements
)
416 AcpiUtDeleteObjectDesc (ObjDesc
);
417 return_ACPI_STATUS (AE_NO_MEMORY
);
421 * Now init the elements of the package
424 Arg
= Op
->Common
.Value
.Arg
;
425 Arg
= Arg
->Common
.Next
;
428 if (Arg
->Common
.AmlOpcode
== AML_INT_RETURN_VALUE_OP
)
430 /* Object (package or buffer) is already built */
432 ObjDesc
->Package
.Elements
[i
] = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT
, Arg
->Common
.Node
);
436 Status
= AcpiDsBuildInternalObject (WalkState
, Arg
,
437 &ObjDesc
->Package
.Elements
[i
]);
441 Arg
= Arg
->Common
.Next
;
444 ObjDesc
->Package
.Flags
|= AOPOBJ_DATA_VALID
;
445 Op
->Common
.Node
= (ACPI_NAMESPACE_NODE
*) ObjDesc
;
446 return_ACPI_STATUS (Status
);
450 /*****************************************************************************
452 * FUNCTION: AcpiDsCreateNode
454 * PARAMETERS: WalkState - Current walk state
455 * Node - NS Node to be initialized
456 * Op - Parser object to be translated
460 * DESCRIPTION: Create the object to be associated with a namespace node
462 ****************************************************************************/
466 ACPI_WALK_STATE
*WalkState
,
467 ACPI_NAMESPACE_NODE
*Node
,
468 ACPI_PARSE_OBJECT
*Op
)
471 ACPI_OPERAND_OBJECT
*ObjDesc
;
474 ACPI_FUNCTION_TRACE_PTR ("DsCreateNode", Op
);
478 * Because of the execution pass through the non-control-method
479 * parts of the table, we can arrive here twice. Only init
480 * the named object node the first time through
482 if (AcpiNsGetAttachedObject (Node
))
484 return_ACPI_STATUS (AE_OK
);
487 if (!Op
->Common
.Value
.Arg
)
489 /* No arguments, there is nothing to do */
491 return_ACPI_STATUS (AE_OK
);
494 /* Build an internal object for the argument(s) */
496 Status
= AcpiDsBuildInternalObject (WalkState
, Op
->Common
.Value
.Arg
, &ObjDesc
);
497 if (ACPI_FAILURE (Status
))
499 return_ACPI_STATUS (Status
);
502 /* Re-type the object according to its argument */
504 Node
->Type
= ACPI_GET_OBJECT_TYPE (ObjDesc
);
506 /* Attach obj to node */
508 Status
= AcpiNsAttachObject (Node
, ObjDesc
, Node
->Type
);
510 /* Remove local reference to the object */
512 AcpiUtRemoveReference (ObjDesc
);
513 return_ACPI_STATUS (Status
);
516 #endif /* ACPI_NO_METHOD_EXECUTION */
519 /*****************************************************************************
521 * FUNCTION: AcpiDsInitObjectFromOp
523 * PARAMETERS: WalkState - Current walk state
524 * Op - Parser op used to init the internal object
525 * Opcode - AML opcode associated with the object
526 * RetObjDesc - Namespace object to be initialized
530 * DESCRIPTION: Initialize a namespace object from a parser Op and its
531 * associated arguments. The namespace object is a more compact
532 * representation of the Op and its arguments.
534 ****************************************************************************/
537 AcpiDsInitObjectFromOp (
538 ACPI_WALK_STATE
*WalkState
,
539 ACPI_PARSE_OBJECT
*Op
,
541 ACPI_OPERAND_OBJECT
**RetObjDesc
)
543 const ACPI_OPCODE_INFO
*OpInfo
;
544 ACPI_OPERAND_OBJECT
*ObjDesc
;
545 ACPI_STATUS Status
= AE_OK
;
548 ACPI_FUNCTION_TRACE ("DsInitObjectFromOp");
551 ObjDesc
= *RetObjDesc
;
552 OpInfo
= AcpiPsGetOpcodeInfo (Opcode
);
553 if (OpInfo
->Class
== AML_CLASS_UNKNOWN
)
557 return_ACPI_STATUS (AE_TYPE
);
560 /* Perform per-object initialization */
562 switch (ACPI_GET_OBJECT_TYPE (ObjDesc
))
564 case ACPI_TYPE_BUFFER
:
567 * Defer evaluation of Buffer TermArg operand
569 ObjDesc
->Buffer
.Node
= (ACPI_NAMESPACE_NODE
*) WalkState
->Operands
[0];
570 ObjDesc
->Buffer
.AmlStart
= Op
->Named
.Data
;
571 ObjDesc
->Buffer
.AmlLength
= Op
->Named
.Length
;
575 case ACPI_TYPE_PACKAGE
:
578 * Defer evaluation of Package TermArg operand
580 ObjDesc
->Package
.Node
= (ACPI_NAMESPACE_NODE
*) WalkState
->Operands
[0];
581 ObjDesc
->Package
.AmlStart
= Op
->Named
.Data
;
582 ObjDesc
->Package
.AmlLength
= Op
->Named
.Length
;
586 case ACPI_TYPE_INTEGER
:
588 switch (OpInfo
->Type
)
590 case AML_TYPE_CONSTANT
:
592 * Resolve AML Constants here - AND ONLY HERE!
593 * All constants are integers.
594 * We mark the integer with a flag that indicates that it started life
595 * as a constant -- so that stores to constants will perform as expected (noop).
596 * (ZeroOp is used as a placeholder for optional target operands.)
598 ObjDesc
->Common
.Flags
= AOPOBJ_AML_CONSTANT
;
604 ObjDesc
->Integer
.Value
= 0;
609 ObjDesc
->Integer
.Value
= 1;
614 ObjDesc
->Integer
.Value
= ACPI_INTEGER_MAX
;
616 /* Truncate value if we are executing from a 32-bit ACPI table */
618 #ifndef ACPI_NO_METHOD_EXECUTION
619 AcpiExTruncateFor32bitTable (ObjDesc
);
623 case AML_REVISION_OP
:
625 ObjDesc
->Integer
.Value
= ACPI_CA_VERSION
;
630 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
, "Unknown constant opcode %X\n", Opcode
));
631 Status
= AE_AML_OPERAND_TYPE
;
637 case AML_TYPE_LITERAL
:
639 ObjDesc
->Integer
.Value
= Op
->Common
.Value
.Integer
;
644 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
, "Unknown Integer type %X\n", OpInfo
->Type
));
645 Status
= AE_AML_OPERAND_TYPE
;
651 case ACPI_TYPE_STRING
:
653 ObjDesc
->String
.Pointer
= Op
->Common
.Value
.String
;
654 ObjDesc
->String
.Length
= (UINT32
) ACPI_STRLEN (Op
->Common
.Value
.String
);
657 * The string is contained in the ACPI table, don't ever try
660 ObjDesc
->Common
.Flags
|= AOPOBJ_STATIC_POINTER
;
664 case ACPI_TYPE_METHOD
:
668 case ACPI_TYPE_LOCAL_REFERENCE
:
670 switch (OpInfo
->Type
)
672 case AML_TYPE_LOCAL_VARIABLE
:
674 /* Split the opcode into a base opcode + offset */
676 ObjDesc
->Reference
.Opcode
= AML_LOCAL_OP
;
677 ObjDesc
->Reference
.Offset
= Opcode
- AML_LOCAL_OP
;
679 #ifndef ACPI_NO_METHOD_EXECUTION
680 Status
= AcpiDsMethodDataGetNode (AML_LOCAL_OP
, ObjDesc
->Reference
.Offset
,
681 WalkState
, (ACPI_NAMESPACE_NODE
**) &ObjDesc
->Reference
.Object
);
686 case AML_TYPE_METHOD_ARGUMENT
:
688 /* Split the opcode into a base opcode + offset */
690 ObjDesc
->Reference
.Opcode
= AML_ARG_OP
;
691 ObjDesc
->Reference
.Offset
= Opcode
- AML_ARG_OP
;
693 #ifndef ACPI_NO_METHOD_EXECUTION
694 Status
= AcpiDsMethodDataGetNode (AML_ARG_OP
, ObjDesc
->Reference
.Offset
,
695 WalkState
, (ACPI_NAMESPACE_NODE
**) &ObjDesc
->Reference
.Object
);
699 default: /* Other literals, etc.. */
701 if (Op
->Common
.AmlOpcode
== AML_INT_NAMEPATH_OP
)
703 /* Node was saved in Op */
705 ObjDesc
->Reference
.Node
= Op
->Common
.Node
;
708 ObjDesc
->Reference
.Opcode
= Opcode
;
716 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
, "Unimplemented data type: %X\n",
717 ACPI_GET_OBJECT_TYPE (ObjDesc
)));
719 Status
= AE_AML_OPERAND_TYPE
;
723 return_ACPI_STATUS (Status
);