1 /******************************************************************************
3 * Module Name: dsobject - Dispatcher object management routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, 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 /*******************************************************************************
166 * FUNCTION: AcpiDsBuildInternalObject
168 * PARAMETERS: WalkState - Current walk state
169 * Op - Parser object to be translated
170 * ObjDescPtr - Where the ACPI internal object is returned
174 * DESCRIPTION: Translate a parser Op object to the equivalent namespace object
175 * Simple objects are any objects other than a package object!
177 ******************************************************************************/
180 AcpiDsBuildInternalObject (
181 ACPI_WALK_STATE *WalkState,
182 ACPI_PARSE_OBJECT *Op,
183 ACPI_OPERAND_OBJECT **ObjDescPtr)
185 ACPI_OPERAND_OBJECT *ObjDesc;
189 ACPI_FUNCTION_TRACE (DsBuildInternalObject);
193 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
196 * This is a named object reference. If this name was
197 * previously looked up in the namespace, it was stored in
198 * this op. Otherwise, go ahead and look it up now
200 if (!Op->Common.Node)
202 /* Check if we are resolving a named reference within a package */
204 if ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
205 (Op->Common.Parent->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
208 * We won't resolve package elements here, we will do this
209 * after all ACPI tables are loaded into the namespace. This
210 * behavior supports both forward references to named objects
211 * and external references to objects in other tables.
213 goto CreateNewObject;
217 Status = AcpiNsLookup (WalkState->ScopeInfo,
218 Op->Common.Value.String,
219 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
220 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE, NULL,
221 ACPI_CAST_INDIRECT_PTR (
222 ACPI_NAMESPACE_NODE, &(Op->Common.Node)));
223 if (ACPI_FAILURE (Status))
225 ACPI_ERROR_NAMESPACE (WalkState->ScopeInfo,
226 Op->Common.Value.String, Status);
227 return_ACPI_STATUS (Status);
235 /* Create and init a new internal ACPI object */
237 ObjDesc = AcpiUtCreateInternalObject (
238 (AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode))->ObjectType);
241 return_ACPI_STATUS (AE_NO_MEMORY);
244 Status = AcpiDsInitObjectFromOp (
245 WalkState, Op, Op->Common.AmlOpcode, &ObjDesc);
246 if (ACPI_FAILURE (Status))
248 AcpiUtRemoveReference (ObjDesc);
249 return_ACPI_STATUS (Status);
253 * Handling for unresolved package reference elements.
254 * These are elements that are namepaths.
256 if ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
257 (Op->Common.Parent->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
259 ObjDesc->Reference.Resolved = TRUE;
261 if ((Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
262 !ObjDesc->Reference.Node)
265 * Name was unresolved above.
266 * Get the prefix node for later lookup
268 ObjDesc->Reference.Node = WalkState->ScopeInfo->Scope.Node;
269 ObjDesc->Reference.Aml = Op->Common.Aml;
270 ObjDesc->Reference.Resolved = FALSE;
274 *ObjDescPtr = ObjDesc;
275 return_ACPI_STATUS (Status);
279 /*******************************************************************************
281 * FUNCTION: AcpiDsBuildInternalBufferObj
283 * PARAMETERS: WalkState - Current walk state
284 * Op - Parser object to be translated
285 * BufferLength - Length of the buffer
286 * ObjDescPtr - Where the ACPI internal object is returned
290 * DESCRIPTION: Translate a parser Op package object to the equivalent
293 ******************************************************************************/
296 AcpiDsBuildInternalBufferObj (
297 ACPI_WALK_STATE *WalkState,
298 ACPI_PARSE_OBJECT *Op,
300 ACPI_OPERAND_OBJECT **ObjDescPtr)
302 ACPI_PARSE_OBJECT *Arg;
303 ACPI_OPERAND_OBJECT *ObjDesc;
304 ACPI_PARSE_OBJECT *ByteList;
305 UINT32 ByteListLength = 0;
308 ACPI_FUNCTION_TRACE (DsBuildInternalBufferObj);
312 * If we are evaluating a Named buffer object "Name (xxxx, Buffer)".
313 * The buffer object already exists (from the NS node), otherwise it must
316 ObjDesc = *ObjDescPtr;
319 /* Create a new buffer object */
321 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
322 *ObjDescPtr = ObjDesc;
325 return_ACPI_STATUS (AE_NO_MEMORY);
330 * Second arg is the buffer data (optional) ByteList can be either
331 * individual bytes or a string initializer. In either case, a
332 * ByteList appears in the AML.
334 Arg = Op->Common.Value.Arg; /* skip first arg */
336 ByteList = Arg->Named.Next;
339 if (ByteList->Common.AmlOpcode != AML_INT_BYTELIST_OP)
341 ACPI_ERROR ((AE_INFO,
342 "Expecting bytelist, found AML opcode 0x%X in op %p",
343 ByteList->Common.AmlOpcode, ByteList));
345 AcpiUtRemoveReference (ObjDesc);
349 ByteListLength = (UINT32) ByteList->Common.Value.Integer;
353 * The buffer length (number of bytes) will be the larger of:
354 * 1) The specified buffer length and
355 * 2) The length of the initializer byte list
357 ObjDesc->Buffer.Length = BufferLength;
358 if (ByteListLength > BufferLength)
360 ObjDesc->Buffer.Length = ByteListLength;
363 /* Allocate the buffer */
365 if (ObjDesc->Buffer.Length == 0)
367 ObjDesc->Buffer.Pointer = NULL;
368 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
369 "Buffer defined with zero length in AML, creating\n"));
373 ObjDesc->Buffer.Pointer =
374 ACPI_ALLOCATE_ZEROED (ObjDesc->Buffer.Length);
375 if (!ObjDesc->Buffer.Pointer)
377 AcpiUtDeleteObjectDesc (ObjDesc);
378 return_ACPI_STATUS (AE_NO_MEMORY);
381 /* Initialize buffer from the ByteList (if present) */
385 memcpy (ObjDesc->Buffer.Pointer, ByteList->Named.Data,
390 ObjDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
391 Op->Common.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjDesc);
392 return_ACPI_STATUS (AE_OK);
395 /*******************************************************************************
397 * FUNCTION: AcpiDsCreateNode
399 * PARAMETERS: WalkState - Current walk state
400 * Node - NS Node to be initialized
401 * Op - Parser object to be translated
405 * DESCRIPTION: Create the object to be associated with a namespace node
407 ******************************************************************************/
411 ACPI_WALK_STATE *WalkState,
412 ACPI_NAMESPACE_NODE *Node,
413 ACPI_PARSE_OBJECT *Op)
416 ACPI_OPERAND_OBJECT *ObjDesc;
419 ACPI_FUNCTION_TRACE_PTR (DsCreateNode, Op);
423 * Because of the execution pass through the non-control-method
424 * parts of the table, we can arrive here twice. Only init
425 * the named object node the first time through
427 if (AcpiNsGetAttachedObject (Node))
429 return_ACPI_STATUS (AE_OK);
432 if (!Op->Common.Value.Arg)
434 /* No arguments, there is nothing to do */
436 return_ACPI_STATUS (AE_OK);
439 /* Build an internal object for the argument(s) */
441 Status = AcpiDsBuildInternalObject (
442 WalkState, Op->Common.Value.Arg, &ObjDesc);
443 if (ACPI_FAILURE (Status))
445 return_ACPI_STATUS (Status);
448 /* Re-type the object according to its argument */
450 Node->Type = ObjDesc->Common.Type;
452 /* Attach obj to node */
454 Status = AcpiNsAttachObject (Node, ObjDesc, Node->Type);
456 /* Remove local reference to the object */
458 AcpiUtRemoveReference (ObjDesc);
459 return_ACPI_STATUS (Status);
463 /*******************************************************************************
465 * FUNCTION: AcpiDsInitObjectFromOp
467 * PARAMETERS: WalkState - Current walk state
468 * Op - Parser op used to init the internal object
469 * Opcode - AML opcode associated with the object
470 * RetObjDesc - Namespace object to be initialized
474 * DESCRIPTION: Initialize a namespace object from a parser Op and its
475 * associated arguments. The namespace object is a more compact
476 * representation of the Op and its arguments.
478 ******************************************************************************/
481 AcpiDsInitObjectFromOp (
482 ACPI_WALK_STATE *WalkState,
483 ACPI_PARSE_OBJECT *Op,
485 ACPI_OPERAND_OBJECT **RetObjDesc)
487 const ACPI_OPCODE_INFO *OpInfo;
488 ACPI_OPERAND_OBJECT *ObjDesc;
489 ACPI_STATUS Status = AE_OK;
492 ACPI_FUNCTION_TRACE (DsInitObjectFromOp);
495 ObjDesc = *RetObjDesc;
496 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
497 if (OpInfo->Class == AML_CLASS_UNKNOWN)
501 return_ACPI_STATUS (AE_TYPE);
504 /* Perform per-object initialization */
506 switch (ObjDesc->Common.Type)
508 case ACPI_TYPE_BUFFER:
510 * Defer evaluation of Buffer TermArg operand
512 ObjDesc->Buffer.Node = ACPI_CAST_PTR (
513 ACPI_NAMESPACE_NODE, WalkState->Operands[0]);
514 ObjDesc->Buffer.AmlStart = Op->Named.Data;
515 ObjDesc->Buffer.AmlLength = Op->Named.Length;
518 case ACPI_TYPE_PACKAGE:
520 * Defer evaluation of Package TermArg operand and all
521 * package elements. (01/2017): We defer the element
522 * resolution to allow forward references from the package
523 * in order to provide compatibility with other ACPI
526 ObjDesc->Package.Node = ACPI_CAST_PTR (
527 ACPI_NAMESPACE_NODE, WalkState->Operands[0]);
531 return_ACPI_STATUS (AE_OK);
534 ObjDesc->Package.AmlStart = Op->Named.Data;
535 ObjDesc->Package.AmlLength = Op->Named.Length;
538 case ACPI_TYPE_INTEGER:
540 switch (OpInfo->Type)
542 case AML_TYPE_CONSTANT:
544 * Resolve AML Constants here - AND ONLY HERE!
545 * All constants are integers.
546 * We mark the integer with a flag that indicates that it started
547 * life as a constant -- so that stores to constants will perform
548 * as expected (noop). ZeroOp is used as a placeholder for optional
551 ObjDesc->Common.Flags = AOPOBJ_AML_CONSTANT;
557 ObjDesc->Integer.Value = 0;
562 ObjDesc->Integer.Value = 1;
567 ObjDesc->Integer.Value = ACPI_UINT64_MAX;
569 /* Truncate value if we are executing from a 32-bit ACPI table */
571 (void) AcpiExTruncateFor32bitTable (ObjDesc);
574 case AML_REVISION_OP:
576 ObjDesc->Integer.Value = ACPI_CA_VERSION;
581 ACPI_ERROR ((AE_INFO,
582 "Unknown constant opcode 0x%X", Opcode));
583 Status = AE_AML_OPERAND_TYPE;
588 case AML_TYPE_LITERAL:
590 ObjDesc->Integer.Value = Op->Common.Value.Integer;
592 if (AcpiExTruncateFor32bitTable (ObjDesc))
594 /* Warn if we found a 64-bit constant in a 32-bit table */
596 ACPI_WARNING ((AE_INFO,
597 "Truncated 64-bit constant found in 32-bit table: %8.8X%8.8X => %8.8X",
598 ACPI_FORMAT_UINT64 (Op->Common.Value.Integer),
599 (UINT32) ObjDesc->Integer.Value));
605 ACPI_ERROR ((AE_INFO, "Unknown Integer type 0x%X",
607 Status = AE_AML_OPERAND_TYPE;
612 case ACPI_TYPE_STRING:
614 ObjDesc->String.Pointer = Op->Common.Value.String;
615 ObjDesc->String.Length = (UINT32) strlen (Op->Common.Value.String);
618 * The string is contained in the ACPI table, don't ever try
621 ObjDesc->Common.Flags |= AOPOBJ_STATIC_POINTER;
624 case ACPI_TYPE_METHOD:
627 case ACPI_TYPE_LOCAL_REFERENCE:
629 switch (OpInfo->Type)
631 case AML_TYPE_LOCAL_VARIABLE:
633 /* Local ID (0-7) is (AML opcode - base AML_FIRST_LOCAL_OP) */
635 ObjDesc->Reference.Value = ((UINT32) Opcode) - AML_FIRST_LOCAL_OP;
636 ObjDesc->Reference.Class = ACPI_REFCLASS_LOCAL;
638 Status = AcpiDsMethodDataGetNode (ACPI_REFCLASS_LOCAL,
639 ObjDesc->Reference.Value, WalkState,
640 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE,
641 &ObjDesc->Reference.Object));
644 case AML_TYPE_METHOD_ARGUMENT:
646 /* Arg ID (0-6) is (AML opcode - base AML_FIRST_ARG_OP) */
648 ObjDesc->Reference.Value = ((UINT32) Opcode) - AML_FIRST_ARG_OP;
649 ObjDesc->Reference.Class = ACPI_REFCLASS_ARG;
651 Status = AcpiDsMethodDataGetNode (ACPI_REFCLASS_ARG,
652 ObjDesc->Reference.Value, WalkState,
653 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE,
654 &ObjDesc->Reference.Object));
657 default: /* Object name or Debug object */
659 switch (Op->Common.AmlOpcode)
661 case AML_INT_NAMEPATH_OP:
663 /* Node was saved in Op */
665 ObjDesc->Reference.Node = Op->Common.Node;
666 ObjDesc->Reference.Class = ACPI_REFCLASS_NAME;
669 ObjDesc->Reference.Object = Op->Common.Node->Object;
675 ObjDesc->Reference.Class = ACPI_REFCLASS_DEBUG;
680 ACPI_ERROR ((AE_INFO,
681 "Unimplemented reference type for AML opcode: 0x%4.4X", Opcode));
682 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
690 ACPI_ERROR ((AE_INFO, "Unimplemented data type: 0x%X",
691 ObjDesc->Common.Type));
693 Status = AE_AML_OPERAND_TYPE;
697 return_ACPI_STATUS (Status);