xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exresnte.c (revision e6eaad8615c4734498b9b800847d18bbe62782fa)
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 - 2013, 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 #define __EXRESNTE_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acdispat.h"
121 #include "acinterp.h"
122 #include "acnamesp.h"
123 
124 
125 #define _COMPONENT          ACPI_EXECUTER
126         ACPI_MODULE_NAME    ("exresnte")
127 
128 
129 /*******************************************************************************
130  *
131  * FUNCTION:    AcpiExResolveNodeToValue
132  *
133  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
134  *                                a pointer to a NS node, and will receive a
135  *                                pointer to the resolved object.
136  *              WalkState       - Current state. Valid only if executing AML
137  *                                code. NULL if simply resolving an object
138  *
139  * RETURN:      Status
140  *
141  * DESCRIPTION: Resolve a Namespace node to a valued object
142  *
143  * Note: for some of the data types, the pointer attached to the Node
144  * can be either a pointer to an actual internal object or a pointer into the
145  * AML stream itself. These types are currently:
146  *
147  *      ACPI_TYPE_INTEGER
148  *      ACPI_TYPE_STRING
149  *      ACPI_TYPE_BUFFER
150  *      ACPI_TYPE_MUTEX
151  *      ACPI_TYPE_PACKAGE
152  *
153  ******************************************************************************/
154 
155 ACPI_STATUS
156 AcpiExResolveNodeToValue (
157     ACPI_NAMESPACE_NODE     **ObjectPtr,
158     ACPI_WALK_STATE         *WalkState)
159 
160 {
161     ACPI_STATUS             Status = AE_OK;
162     ACPI_OPERAND_OBJECT     *SourceDesc;
163     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
164     ACPI_NAMESPACE_NODE     *Node;
165     ACPI_OBJECT_TYPE        EntryType;
166 
167 
168     ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
169 
170 
171     /*
172      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node). Get the
173      * object that is attached to the Node.
174      */
175     Node       = *ObjectPtr;
176     SourceDesc = AcpiNsGetAttachedObject (Node);
177     EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
178 
179     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
180          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
181 
182     if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
183         (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
184     {
185         /* There is always exactly one level of indirection */
186 
187         Node       = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
188         SourceDesc = AcpiNsGetAttachedObject (Node);
189         EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
190         *ObjectPtr = Node;
191     }
192 
193     /*
194      * Several object types require no further processing:
195      * 1) Device/Thermal objects don't have a "real" subobject, return the Node
196      * 2) Method locals and arguments have a pseudo-Node
197      * 3) 10/2007: Added method type to assist with Package construction.
198      */
199     if ((EntryType == ACPI_TYPE_DEVICE)  ||
200         (EntryType == ACPI_TYPE_THERMAL) ||
201         (EntryType == ACPI_TYPE_METHOD)  ||
202         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
203     {
204         return_ACPI_STATUS (AE_OK);
205     }
206 
207     if (!SourceDesc)
208     {
209         ACPI_ERROR ((AE_INFO, "No object attached to node %p",
210             Node));
211         return_ACPI_STATUS (AE_AML_NO_OPERAND);
212     }
213 
214     /*
215      * Action is based on the type of the Node, which indicates the type
216      * of the attached object or pointer
217      */
218     switch (EntryType)
219     {
220     case ACPI_TYPE_PACKAGE:
221 
222         if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
223         {
224             ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
225                 AcpiUtGetObjectTypeName (SourceDesc)));
226             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
227         }
228 
229         Status = AcpiDsGetPackageArguments (SourceDesc);
230         if (ACPI_SUCCESS (Status))
231         {
232             /* Return an additional reference to the object */
233 
234             ObjDesc = SourceDesc;
235             AcpiUtAddReference (ObjDesc);
236         }
237         break;
238 
239     case ACPI_TYPE_BUFFER:
240 
241         if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
242         {
243             ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
244                 AcpiUtGetObjectTypeName (SourceDesc)));
245             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
246         }
247 
248         Status = AcpiDsGetBufferArguments (SourceDesc);
249         if (ACPI_SUCCESS (Status))
250         {
251             /* Return an additional reference to the object */
252 
253             ObjDesc = SourceDesc;
254             AcpiUtAddReference (ObjDesc);
255         }
256         break;
257 
258     case ACPI_TYPE_STRING:
259 
260         if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
261         {
262             ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
263                 AcpiUtGetObjectTypeName (SourceDesc)));
264             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
265         }
266 
267         /* Return an additional reference to the object */
268 
269         ObjDesc = SourceDesc;
270         AcpiUtAddReference (ObjDesc);
271         break;
272 
273     case ACPI_TYPE_INTEGER:
274 
275         if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
276         {
277             ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
278                 AcpiUtGetObjectTypeName (SourceDesc)));
279             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
280         }
281 
282         /* Return an additional reference to the object */
283 
284         ObjDesc = SourceDesc;
285         AcpiUtAddReference (ObjDesc);
286         break;
287 
288     case ACPI_TYPE_BUFFER_FIELD:
289     case ACPI_TYPE_LOCAL_REGION_FIELD:
290     case ACPI_TYPE_LOCAL_BANK_FIELD:
291     case ACPI_TYPE_LOCAL_INDEX_FIELD:
292 
293         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
294             "FieldRead Node=%p SourceDesc=%p Type=%X\n",
295             Node, SourceDesc, EntryType));
296 
297         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
298         break;
299 
300     /* For these objects, just return the object attached to the Node */
301 
302     case ACPI_TYPE_MUTEX:
303     case ACPI_TYPE_POWER:
304     case ACPI_TYPE_PROCESSOR:
305     case ACPI_TYPE_EVENT:
306     case ACPI_TYPE_REGION:
307 
308         /* Return an additional reference to the object */
309 
310         ObjDesc = SourceDesc;
311         AcpiUtAddReference (ObjDesc);
312         break;
313 
314     /* TYPE_ANY is untyped, and thus there is no object associated with it */
315 
316     case ACPI_TYPE_ANY:
317 
318         ACPI_ERROR ((AE_INFO,
319             "Untyped entry %p, no attached object!", Node));
320 
321         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
322 
323     case ACPI_TYPE_LOCAL_REFERENCE:
324 
325         switch (SourceDesc->Reference.Class)
326         {
327         case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
328         case ACPI_REFCLASS_REFOF:
329         case ACPI_REFCLASS_INDEX:
330 
331             /* Return an additional reference to the object */
332 
333             ObjDesc = SourceDesc;
334             AcpiUtAddReference (ObjDesc);
335             break;
336 
337         default:
338 
339             /* No named references are allowed here */
340 
341             ACPI_ERROR ((AE_INFO,
342                 "Unsupported Reference type 0x%X",
343                 SourceDesc->Reference.Class));
344 
345             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
346         }
347         break;
348 
349     default:
350 
351         /* Default case is for unknown types */
352 
353         ACPI_ERROR ((AE_INFO,
354             "Node %p - Unknown object type 0x%X",
355             Node, EntryType));
356 
357         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
358 
359     } /* switch (EntryType) */
360 
361 
362     /* Return the object descriptor */
363 
364     *ObjectPtr = (void *) ObjDesc;
365     return_ACPI_STATUS (Status);
366 }
367