1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acparser.h>
155 #include <contrib/dev/acpica/include/amlcode.h>
156 #include <contrib/dev/acpica/include/acdispat.h>
157 #include <contrib/dev/acpica/include/acnamesp.h>
158 #include <contrib/dev/acpica/include/acinterp.h>
160 #define _COMPONENT ACPI_DISPATCHER
161 ACPI_MODULE_NAME ("dsobject")
164 #ifndef ACPI_NO_METHOD_EXECUTION
165 /*******************************************************************************
167 * FUNCTION: AcpiDsBuildInternalObject
169 * PARAMETERS: WalkState - Current walk state
170 * Op - Parser object to be translated
171 * ObjDescPtr - Where the ACPI internal object is returned
175 * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
176 * Simple objects are any objects other than a package object!
178 ******************************************************************************/
181 AcpiDsBuildInternalObject (
182 ACPI_WALK_STATE *WalkState,
183 ACPI_PARSE_OBJECT *Op,
184 ACPI_OPERAND_OBJECT **ObjDescPtr)
186 ACPI_OPERAND_OBJECT *ObjDesc;
190 ACPI_FUNCTION_TRACE (DsBuildInternalObject);
194 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
197 * This is a named object reference. If this name was
198 * previously looked up in the namespace, it was stored in
199 * this op. Otherwise, go ahead and look it up now
201 if (!Op->Common.Node)
203 /* Check if we are resolving a named reference within a package */
205 if ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
206 (Op->Common.Parent->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
209 * We won't resolve package elements here, we will do this
210 * after all ACPI tables are loaded into the namespace. This
211 * behavior supports both forward references to named objects
212 * and external references to objects in other tables.
214 goto CreateNewObject;
218 Status = AcpiNsLookup (WalkState->ScopeInfo,
219 Op->Common.Value.String,
220 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
221 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE, NULL,
222 ACPI_CAST_INDIRECT_PTR (
223 ACPI_NAMESPACE_NODE, &(Op->Common.Node)));
224 if (ACPI_FAILURE (Status))
226 ACPI_ERROR_NAMESPACE (WalkState->ScopeInfo,
227 Op->Common.Value.String, Status);
228 return_ACPI_STATUS (Status);
236 /* Create and init a new internal ACPI object */
238 ObjDesc = AcpiUtCreateInternalObject (
239 (AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode))->ObjectType);
242 return_ACPI_STATUS (AE_NO_MEMORY);
245 Status = AcpiDsInitObjectFromOp (
246 WalkState, Op, Op->Common.AmlOpcode, &ObjDesc);
247 if (ACPI_FAILURE (Status))
249 AcpiUtRemoveReference (ObjDesc);
250 return_ACPI_STATUS (Status);
254 * Handling for unresolved package reference elements.
255 * These are elements that are namepaths.
257 if ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
258 (Op->Common.Parent->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
260 ObjDesc->Reference.Resolved = TRUE;
262 if ((Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
263 !ObjDesc->Reference.Node)
266 * Name was unresolved above.
267 * Get the prefix node for later lookup
269 ObjDesc->Reference.Node = WalkState->ScopeInfo->Scope.Node;
270 ObjDesc->Reference.Aml = Op->Common.Aml;
271 ObjDesc->Reference.Resolved = FALSE;
275 *ObjDescPtr = ObjDesc;
276 return_ACPI_STATUS (Status);
280 /*******************************************************************************
282 * FUNCTION: AcpiDsBuildInternalBufferObj
284 * PARAMETERS: WalkState - Current walk state
285 * Op - Parser object to be translated
286 * BufferLength - Length of the buffer
287 * ObjDescPtr - Where the ACPI internal object is returned
291 * DESCRIPTION: Translate a parser Op package object to the equivalent
294 ******************************************************************************/
297 AcpiDsBuildInternalBufferObj (
298 ACPI_WALK_STATE *WalkState,
299 ACPI_PARSE_OBJECT *Op,
301 ACPI_OPERAND_OBJECT **ObjDescPtr)
303 ACPI_PARSE_OBJECT *Arg;
304 ACPI_OPERAND_OBJECT *ObjDesc;
305 ACPI_PARSE_OBJECT *ByteList;
306 UINT32 ByteListLength = 0;
309 ACPI_FUNCTION_TRACE (DsBuildInternalBufferObj);
313 * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
314 * The buffer object already exists (from the NS node), otherwise it must
317 ObjDesc = *ObjDescPtr;
320 /* Create a new buffer object */
322 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
323 *ObjDescPtr = ObjDesc;
326 return_ACPI_STATUS (AE_NO_MEMORY);
331 * Second arg is the buffer data (optional) ByteList can be either
332 * individual bytes or a string initializer. In either case, a
333 * ByteList appears in the AML.
335 Arg = Op->Common.Value.Arg; /* skip first arg */
337 ByteList = Arg->Named.Next;
340 if (ByteList->Common.AmlOpcode != AML_INT_BYTELIST_OP)
342 ACPI_ERROR ((AE_INFO,
343 "Expecting bytelist, found AML opcode 0x%X in op %p",
344 ByteList->Common.AmlOpcode, ByteList));
346 AcpiUtRemoveReference (ObjDesc);
350 ByteListLength = (UINT32) ByteList->Common.Value.Integer;
354 * The buffer length (number of bytes) will be the larger of:
355 * 1) The specified buffer length and
356 * 2) The length of the initializer byte list
358 ObjDesc->Buffer.Length = BufferLength;
359 if (ByteListLength > BufferLength)
361 ObjDesc->Buffer.Length = ByteListLength;
364 /* Allocate the buffer */
366 if (ObjDesc->Buffer.Length == 0)
368 ObjDesc->Buffer.Pointer = NULL;
369 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
370 "Buffer defined with zero length in AML, creating\n"));
374 ObjDesc->Buffer.Pointer =
375 ACPI_ALLOCATE_ZEROED (ObjDesc->Buffer.Length);
376 if (!ObjDesc->Buffer.Pointer)
378 AcpiUtDeleteObjectDesc (ObjDesc);
379 return_ACPI_STATUS (AE_NO_MEMORY);
382 /* Initialize buffer from the ByteList (if present) */
386 memcpy (ObjDesc->Buffer.Pointer, ByteList->Named.Data,
391 ObjDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
392 Op->Common.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjDesc);
393 return_ACPI_STATUS (AE_OK);
396 /*******************************************************************************
398 * FUNCTION: AcpiDsCreateNode
400 * PARAMETERS: WalkState - Current walk state
401 * Node - NS Node to be initialized
402 * Op - Parser object to be translated
406 * DESCRIPTION: Create the object to be associated with a namespace node
408 ******************************************************************************/
412 ACPI_WALK_STATE *WalkState,
413 ACPI_NAMESPACE_NODE *Node,
414 ACPI_PARSE_OBJECT *Op)
417 ACPI_OPERAND_OBJECT *ObjDesc;
420 ACPI_FUNCTION_TRACE_PTR (DsCreateNode, Op);
424 * Because of the execution pass through the non-control-method
425 * parts of the table, we can arrive here twice. Only init
426 * the named object node the first time through
428 if (AcpiNsGetAttachedObject (Node))
430 return_ACPI_STATUS (AE_OK);
433 if (!Op->Common.Value.Arg)
435 /* No arguments, there is nothing to do */
437 return_ACPI_STATUS (AE_OK);
440 /* Build an internal object for the argument(s) */
442 Status = AcpiDsBuildInternalObject (
443 WalkState, Op->Common.Value.Arg, &ObjDesc);
444 if (ACPI_FAILURE (Status))
446 return_ACPI_STATUS (Status);
449 /* Re-type the object according to its argument */
451 Node->Type = ObjDesc->Common.Type;
453 /* Attach obj to node */
455 Status = AcpiNsAttachObject (Node, ObjDesc, Node->Type);
457 /* Remove local reference to the object */
459 AcpiUtRemoveReference (ObjDesc);
460 return_ACPI_STATUS (Status);
463 #endif /* ACPI_NO_METHOD_EXECUTION */
466 /*******************************************************************************
468 * FUNCTION: AcpiDsInitObjectFromOp
470 * PARAMETERS: WalkState - Current walk state
471 * Op - Parser op used to init the internal object
472 * Opcode - AML opcode associated with the object
473 * RetObjDesc - Namespace object to be initialized
477 * DESCRIPTION: Initialize a namespace object from a parser Op and its
478 * associated arguments. The namespace object is a more compact
479 * representation of the Op and its arguments.
481 ******************************************************************************/
484 AcpiDsInitObjectFromOp (
485 ACPI_WALK_STATE *WalkState,
486 ACPI_PARSE_OBJECT *Op,
488 ACPI_OPERAND_OBJECT **RetObjDesc)
490 const ACPI_OPCODE_INFO *OpInfo;
491 ACPI_OPERAND_OBJECT *ObjDesc;
492 ACPI_STATUS Status = AE_OK;
495 ACPI_FUNCTION_TRACE (DsInitObjectFromOp);
498 ObjDesc = *RetObjDesc;
499 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
500 if (OpInfo->Class == AML_CLASS_UNKNOWN)
504 return_ACPI_STATUS (AE_TYPE);
507 /* Perform per-object initialization */
509 switch (ObjDesc->Common.Type)
511 case ACPI_TYPE_BUFFER:
513 * Defer evaluation of Buffer TermArg operand
515 ObjDesc->Buffer.Node = ACPI_CAST_PTR (
516 ACPI_NAMESPACE_NODE, WalkState->Operands[0]);
517 ObjDesc->Buffer.AmlStart = Op->Named.Data;
518 ObjDesc->Buffer.AmlLength = Op->Named.Length;
521 case ACPI_TYPE_PACKAGE:
523 * Defer evaluation of Package TermArg operand and all
524 * package elements. (01/2017): We defer the element
525 * resolution to allow forward references from the package
526 * in order to provide compatibility with other ACPI
529 ObjDesc->Package.Node = ACPI_CAST_PTR (
530 ACPI_NAMESPACE_NODE, WalkState->Operands[0]);
534 return_ACPI_STATUS (AE_OK);
537 ObjDesc->Package.AmlStart = Op->Named.Data;
538 ObjDesc->Package.AmlLength = Op->Named.Length;
541 case ACPI_TYPE_INTEGER:
543 switch (OpInfo->Type)
545 case AML_TYPE_CONSTANT:
547 * Resolve AML Constants here - AND ONLY HERE!
548 * All constants are integers.
549 * We mark the integer with a flag that indicates that it started
550 * life as a constant -- so that stores to constants will perform
551 * as expected (noop). ZeroOp is used as a placeholder for optional
554 ObjDesc->Common.Flags = AOPOBJ_AML_CONSTANT;
560 ObjDesc->Integer.Value = 0;
565 ObjDesc->Integer.Value = 1;
570 ObjDesc->Integer.Value = ACPI_UINT64_MAX;
572 /* Truncate value if we are executing from a 32-bit ACPI table */
574 #ifndef ACPI_NO_METHOD_EXECUTION
575 (void) AcpiExTruncateFor32bitTable (ObjDesc);
579 case AML_REVISION_OP:
581 ObjDesc->Integer.Value = ACPI_CA_VERSION;
586 ACPI_ERROR ((AE_INFO,
587 "Unknown constant opcode 0x%X", Opcode));
588 Status = AE_AML_OPERAND_TYPE;
593 case AML_TYPE_LITERAL:
595 ObjDesc->Integer.Value = Op->Common.Value.Integer;
597 #ifndef ACPI_NO_METHOD_EXECUTION
598 if (AcpiExTruncateFor32bitTable (ObjDesc))
600 /* Warn if we found a 64-bit constant in a 32-bit table */
602 ACPI_WARNING ((AE_INFO,
603 "Truncated 64-bit constant found in 32-bit table: %8.8X%8.8X => %8.8X",
604 ACPI_FORMAT_UINT64 (Op->Common.Value.Integer),
605 (UINT32) ObjDesc->Integer.Value));
612 ACPI_ERROR ((AE_INFO, "Unknown Integer type 0x%X",
614 Status = AE_AML_OPERAND_TYPE;
619 case ACPI_TYPE_STRING:
621 ObjDesc->String.Pointer = Op->Common.Value.String;
622 ObjDesc->String.Length = (UINT32) strlen (Op->Common.Value.String);
625 * The string is contained in the ACPI table, don't ever try
628 ObjDesc->Common.Flags |= AOPOBJ_STATIC_POINTER;
631 case ACPI_TYPE_METHOD:
634 case ACPI_TYPE_LOCAL_REFERENCE:
636 switch (OpInfo->Type)
638 case AML_TYPE_LOCAL_VARIABLE:
640 /* Local ID (0-7) is (AML opcode - base AML_FIRST_LOCAL_OP) */
642 ObjDesc->Reference.Value = ((UINT32) Opcode) - AML_FIRST_LOCAL_OP;
643 ObjDesc->Reference.Class = ACPI_REFCLASS_LOCAL;
645 #ifndef ACPI_NO_METHOD_EXECUTION
646 Status = AcpiDsMethodDataGetNode (ACPI_REFCLASS_LOCAL,
647 ObjDesc->Reference.Value, WalkState,
648 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE,
649 &ObjDesc->Reference.Object));
653 case AML_TYPE_METHOD_ARGUMENT:
655 /* Arg ID (0-6) is (AML opcode - base AML_FIRST_ARG_OP) */
657 ObjDesc->Reference.Value = ((UINT32) Opcode) - AML_FIRST_ARG_OP;
658 ObjDesc->Reference.Class = ACPI_REFCLASS_ARG;
660 #ifndef ACPI_NO_METHOD_EXECUTION
661 Status = AcpiDsMethodDataGetNode (ACPI_REFCLASS_ARG,
662 ObjDesc->Reference.Value, WalkState,
663 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE,
664 &ObjDesc->Reference.Object));
668 default: /* Object name or Debug object */
670 switch (Op->Common.AmlOpcode)
672 case AML_INT_NAMEPATH_OP:
674 /* Node was saved in Op */
676 ObjDesc->Reference.Node = Op->Common.Node;
677 ObjDesc->Reference.Class = ACPI_REFCLASS_NAME;
680 ObjDesc->Reference.Object = Op->Common.Node->Object;
686 ObjDesc->Reference.Class = ACPI_REFCLASS_DEBUG;
691 ACPI_ERROR ((AE_INFO,
692 "Unimplemented reference type for AML opcode: 0x%4.4X", Opcode));
693 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
701 ACPI_ERROR ((AE_INFO, "Unimplemented data type: 0x%X",
702 ObjDesc->Common.Type));
704 Status = AE_AML_OPERAND_TYPE;
708 return_ACPI_STATUS (Status);