xref: /freebsd/sys/contrib/dev/acpica/components/executer/exresnte.c (revision 56e53cb8ef000c3ef72337a4095987a932cdedef)
1 /******************************************************************************
2  *
3  * Module Name: exresnte - AML Interpreter object resolution
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acdispat.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156 #include <contrib/dev/acpica/include/acnamesp.h>
157 
158 
159 #define _COMPONENT          ACPI_EXECUTER
160         ACPI_MODULE_NAME    ("exresnte")
161 
162 
163 /*******************************************************************************
164  *
165  * FUNCTION:    AcpiExResolveNodeToValue
166  *
167  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
168  *                                a pointer to a NS node, and will receive a
169  *                                pointer to the resolved object.
170  *              WalkState       - Current state. Valid only if executing AML
171  *                                code. NULL if simply resolving an object
172  *
173  * RETURN:      Status
174  *
175  * DESCRIPTION: Resolve a Namespace node to a valued object
176  *
177  * Note: for some of the data types, the pointer attached to the Node
178  * can be either a pointer to an actual internal object or a pointer into the
179  * AML stream itself. These types are currently:
180  *
181  *      ACPI_TYPE_INTEGER
182  *      ACPI_TYPE_STRING
183  *      ACPI_TYPE_BUFFER
184  *      ACPI_TYPE_MUTEX
185  *      ACPI_TYPE_PACKAGE
186  *
187  ******************************************************************************/
188 
189 ACPI_STATUS
190 AcpiExResolveNodeToValue (
191     ACPI_NAMESPACE_NODE     **ObjectPtr,
192     ACPI_WALK_STATE         *WalkState)
193 
194 {
195     ACPI_STATUS             Status = AE_OK;
196     ACPI_OPERAND_OBJECT     *SourceDesc;
197     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
198     ACPI_NAMESPACE_NODE     *Node;
199     ACPI_OBJECT_TYPE        EntryType;
200 
201 
202     ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
203 
204 
205     /*
206      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node). Get the
207      * object that is attached to the Node.
208      */
209     Node = *ObjectPtr;
210     SourceDesc = AcpiNsGetAttachedObject (Node);
211     EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
212 
213     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
214          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
215 
216     if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
217         (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
218     {
219         /* There is always exactly one level of indirection */
220 
221         Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
222         SourceDesc = AcpiNsGetAttachedObject (Node);
223         EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
224         *ObjectPtr = Node;
225     }
226 
227     /*
228      * Several object types require no further processing:
229      * 1) Device/Thermal objects don't have a "real" subobject, return Node
230      * 2) Method locals and arguments have a pseudo-Node
231      * 3) 10/2007: Added method type to assist with Package construction.
232      */
233     if ((EntryType == ACPI_TYPE_DEVICE)  ||
234         (EntryType == ACPI_TYPE_THERMAL) ||
235         (EntryType == ACPI_TYPE_METHOD)  ||
236         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
237     {
238         return_ACPI_STATUS (AE_OK);
239     }
240 
241     if (!SourceDesc)
242     {
243         ACPI_ERROR ((AE_INFO, "No object attached to node [%4.4s] %p",
244             Node->Name.Ascii, Node));
245         return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE);
246     }
247 
248     /*
249      * Action is based on the type of the Node, which indicates the type
250      * of the attached object or pointer
251      */
252     switch (EntryType)
253     {
254     case ACPI_TYPE_PACKAGE:
255 
256         if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
257         {
258             ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
259                 AcpiUtGetObjectTypeName (SourceDesc)));
260             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
261         }
262 
263         Status = AcpiDsGetPackageArguments (SourceDesc);
264         if (ACPI_SUCCESS (Status))
265         {
266             /* Return an additional reference to the object */
267 
268             ObjDesc = SourceDesc;
269             AcpiUtAddReference (ObjDesc);
270         }
271         break;
272 
273     case ACPI_TYPE_BUFFER:
274 
275         if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
276         {
277             ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
278                 AcpiUtGetObjectTypeName (SourceDesc)));
279             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
280         }
281 
282         Status = AcpiDsGetBufferArguments (SourceDesc);
283         if (ACPI_SUCCESS (Status))
284         {
285             /* Return an additional reference to the object */
286 
287             ObjDesc = SourceDesc;
288             AcpiUtAddReference (ObjDesc);
289         }
290         break;
291 
292     case ACPI_TYPE_STRING:
293 
294         if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
295         {
296             ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
297                 AcpiUtGetObjectTypeName (SourceDesc)));
298             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
299         }
300 
301         /* Return an additional reference to the object */
302 
303         ObjDesc = SourceDesc;
304         AcpiUtAddReference (ObjDesc);
305         break;
306 
307     case ACPI_TYPE_INTEGER:
308 
309         if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
310         {
311             ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
312                 AcpiUtGetObjectTypeName (SourceDesc)));
313             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
314         }
315 
316         /* Return an additional reference to the object */
317 
318         ObjDesc = SourceDesc;
319         AcpiUtAddReference (ObjDesc);
320         break;
321 
322     case ACPI_TYPE_BUFFER_FIELD:
323     case ACPI_TYPE_LOCAL_REGION_FIELD:
324     case ACPI_TYPE_LOCAL_BANK_FIELD:
325     case ACPI_TYPE_LOCAL_INDEX_FIELD:
326 
327         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
328             "FieldRead Node=%p SourceDesc=%p Type=%X\n",
329             Node, SourceDesc, EntryType));
330 
331         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
332         break;
333 
334     /* For these objects, just return the object attached to the Node */
335 
336     case ACPI_TYPE_MUTEX:
337     case ACPI_TYPE_POWER:
338     case ACPI_TYPE_PROCESSOR:
339     case ACPI_TYPE_EVENT:
340     case ACPI_TYPE_REGION:
341 
342         /* Return an additional reference to the object */
343 
344         ObjDesc = SourceDesc;
345         AcpiUtAddReference (ObjDesc);
346         break;
347 
348     /* TYPE_ANY is untyped, and thus there is no object associated with it */
349 
350     case ACPI_TYPE_ANY:
351 
352         ACPI_ERROR ((AE_INFO,
353             "Untyped entry %p, no attached object!", Node));
354 
355         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
356 
357     case ACPI_TYPE_LOCAL_REFERENCE:
358 
359         switch (SourceDesc->Reference.Class)
360         {
361         case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
362         case ACPI_REFCLASS_REFOF:
363         case ACPI_REFCLASS_INDEX:
364 
365             /* Return an additional reference to the object */
366 
367             ObjDesc = SourceDesc;
368             AcpiUtAddReference (ObjDesc);
369             break;
370 
371         default:
372 
373             /* No named references are allowed here */
374 
375             ACPI_ERROR ((AE_INFO,
376                 "Unsupported Reference type 0x%X",
377                 SourceDesc->Reference.Class));
378 
379             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
380         }
381         break;
382 
383     default:
384 
385         /* Default case is for unknown types */
386 
387         ACPI_ERROR ((AE_INFO,
388             "Node %p - Unknown object type 0x%X",
389             Node, EntryType));
390 
391         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
392 
393     } /* switch (EntryType) */
394 
395 
396     /* Return the object descriptor */
397 
398     *ObjectPtr = (void *) ObjDesc;
399     return_ACPI_STATUS (Status);
400 }
401