xref: /minix3/minix/drivers/power/acpi/namespace/nssearch.c (revision 433d6423c39e34ec4b79c950597bb2d236f886be)
1*433d6423SLionel Sambuc /*******************************************************************************
2*433d6423SLionel Sambuc  *
3*433d6423SLionel Sambuc  * Module Name: nssearch - Namespace search
4*433d6423SLionel Sambuc  *
5*433d6423SLionel Sambuc  ******************************************************************************/
6*433d6423SLionel Sambuc 
7*433d6423SLionel Sambuc /******************************************************************************
8*433d6423SLionel Sambuc  *
9*433d6423SLionel Sambuc  * 1. Copyright Notice
10*433d6423SLionel Sambuc  *
11*433d6423SLionel Sambuc  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12*433d6423SLionel Sambuc  * All rights reserved.
13*433d6423SLionel Sambuc  *
14*433d6423SLionel Sambuc  * 2. License
15*433d6423SLionel Sambuc  *
16*433d6423SLionel Sambuc  * 2.1. This is your license from Intel Corp. under its intellectual property
17*433d6423SLionel Sambuc  * rights.  You may have additional license terms from the party that provided
18*433d6423SLionel Sambuc  * you this software, covering your right to use that party's intellectual
19*433d6423SLionel Sambuc  * property rights.
20*433d6423SLionel Sambuc  *
21*433d6423SLionel Sambuc  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*433d6423SLionel Sambuc  * copy of the source code appearing in this file ("Covered Code") an
23*433d6423SLionel Sambuc  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*433d6423SLionel Sambuc  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*433d6423SLionel Sambuc  * make derivatives, distribute, use and display any portion of the Covered
26*433d6423SLionel Sambuc  * Code in any form, with the right to sublicense such rights; and
27*433d6423SLionel Sambuc  *
28*433d6423SLionel Sambuc  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*433d6423SLionel Sambuc  * license (with the right to sublicense), under only those claims of Intel
30*433d6423SLionel Sambuc  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*433d6423SLionel Sambuc  * offer to sell, and import the Covered Code and derivative works thereof
32*433d6423SLionel Sambuc  * solely to the minimum extent necessary to exercise the above copyright
33*433d6423SLionel Sambuc  * license, and in no event shall the patent license extend to any additions
34*433d6423SLionel Sambuc  * to or modifications of the Original Intel Code.  No other license or right
35*433d6423SLionel Sambuc  * is granted directly or by implication, estoppel or otherwise;
36*433d6423SLionel Sambuc  *
37*433d6423SLionel Sambuc  * The above copyright and patent license is granted only if the following
38*433d6423SLionel Sambuc  * conditions are met:
39*433d6423SLionel Sambuc  *
40*433d6423SLionel Sambuc  * 3. Conditions
41*433d6423SLionel Sambuc  *
42*433d6423SLionel Sambuc  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*433d6423SLionel Sambuc  * Redistribution of source code of any substantial portion of the Covered
44*433d6423SLionel Sambuc  * Code or modification with rights to further distribute source must include
45*433d6423SLionel Sambuc  * the above Copyright Notice, the above License, this list of Conditions,
46*433d6423SLionel Sambuc  * and the following Disclaimer and Export Compliance provision.  In addition,
47*433d6423SLionel Sambuc  * Licensee must cause all Covered Code to which Licensee contributes to
48*433d6423SLionel Sambuc  * contain a file documenting the changes Licensee made to create that Covered
49*433d6423SLionel Sambuc  * Code and the date of any change.  Licensee must include in that file the
50*433d6423SLionel Sambuc  * documentation of any changes made by any predecessor Licensee.  Licensee
51*433d6423SLionel Sambuc  * must include a prominent statement that the modification is derived,
52*433d6423SLionel Sambuc  * directly or indirectly, from Original Intel Code.
53*433d6423SLionel Sambuc  *
54*433d6423SLionel Sambuc  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*433d6423SLionel Sambuc  * Redistribution of source code of any substantial portion of the Covered
56*433d6423SLionel Sambuc  * Code or modification without rights to further distribute source must
57*433d6423SLionel Sambuc  * include the following Disclaimer and Export Compliance provision in the
58*433d6423SLionel Sambuc  * documentation and/or other materials provided with distribution.  In
59*433d6423SLionel Sambuc  * addition, Licensee may not authorize further sublicense of source of any
60*433d6423SLionel Sambuc  * portion of the Covered Code, and must include terms to the effect that the
61*433d6423SLionel Sambuc  * license from Licensee to its licensee is limited to the intellectual
62*433d6423SLionel Sambuc  * property embodied in the software Licensee provides to its licensee, and
63*433d6423SLionel Sambuc  * not to intellectual property embodied in modifications its licensee may
64*433d6423SLionel Sambuc  * make.
65*433d6423SLionel Sambuc  *
66*433d6423SLionel Sambuc  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*433d6423SLionel Sambuc  * substantial portion of the Covered Code or modification must reproduce the
68*433d6423SLionel Sambuc  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*433d6423SLionel Sambuc  * provision in the documentation and/or other materials provided with the
70*433d6423SLionel Sambuc  * distribution.
71*433d6423SLionel Sambuc  *
72*433d6423SLionel Sambuc  * 3.4. Intel retains all right, title, and interest in and to the Original
73*433d6423SLionel Sambuc  * Intel Code.
74*433d6423SLionel Sambuc  *
75*433d6423SLionel Sambuc  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*433d6423SLionel Sambuc  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*433d6423SLionel Sambuc  * other dealings in products derived from or relating to the Covered Code
78*433d6423SLionel Sambuc  * without prior written authorization from Intel.
79*433d6423SLionel Sambuc  *
80*433d6423SLionel Sambuc  * 4. Disclaimer and Export Compliance
81*433d6423SLionel Sambuc  *
82*433d6423SLionel Sambuc  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*433d6423SLionel Sambuc  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*433d6423SLionel Sambuc  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85*433d6423SLionel Sambuc  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86*433d6423SLionel Sambuc  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87*433d6423SLionel Sambuc  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*433d6423SLionel Sambuc  * PARTICULAR PURPOSE.
89*433d6423SLionel Sambuc  *
90*433d6423SLionel Sambuc  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*433d6423SLionel Sambuc  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*433d6423SLionel Sambuc  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*433d6423SLionel Sambuc  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*433d6423SLionel Sambuc  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*433d6423SLionel Sambuc  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96*433d6423SLionel Sambuc  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*433d6423SLionel Sambuc  * LIMITED REMEDY.
98*433d6423SLionel Sambuc  *
99*433d6423SLionel Sambuc  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*433d6423SLionel Sambuc  * software or system incorporating such software without first obtaining any
101*433d6423SLionel Sambuc  * required license or other approval from the U. S. Department of Commerce or
102*433d6423SLionel Sambuc  * any other agency or department of the United States Government.  In the
103*433d6423SLionel Sambuc  * event Licensee exports any such software from the United States or
104*433d6423SLionel Sambuc  * re-exports any such software from a foreign destination, Licensee shall
105*433d6423SLionel Sambuc  * ensure that the distribution and export/re-export of the software is in
106*433d6423SLionel Sambuc  * compliance with all laws, regulations, orders, or other restrictions of the
107*433d6423SLionel Sambuc  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*433d6423SLionel Sambuc  * any of its subsidiaries will export/re-export any technical data, process,
109*433d6423SLionel Sambuc  * software, or service, directly or indirectly, to any country for which the
110*433d6423SLionel Sambuc  * United States government or any agency thereof requires an export license,
111*433d6423SLionel Sambuc  * other governmental approval, or letter of assurance, without first obtaining
112*433d6423SLionel Sambuc  * such license, approval or letter.
113*433d6423SLionel Sambuc  *
114*433d6423SLionel Sambuc  *****************************************************************************/
115*433d6423SLionel Sambuc 
116*433d6423SLionel Sambuc #define __NSSEARCH_C__
117*433d6423SLionel Sambuc 
118*433d6423SLionel Sambuc #include "acpi.h"
119*433d6423SLionel Sambuc #include "accommon.h"
120*433d6423SLionel Sambuc #include "acnamesp.h"
121*433d6423SLionel Sambuc 
122*433d6423SLionel Sambuc #ifdef ACPI_ASL_COMPILER
123*433d6423SLionel Sambuc #include "amlcode.h"
124*433d6423SLionel Sambuc #endif
125*433d6423SLionel Sambuc 
126*433d6423SLionel Sambuc #define _COMPONENT          ACPI_NAMESPACE
127*433d6423SLionel Sambuc         ACPI_MODULE_NAME    ("nssearch")
128*433d6423SLionel Sambuc 
129*433d6423SLionel Sambuc /* Local prototypes */
130*433d6423SLionel Sambuc 
131*433d6423SLionel Sambuc static ACPI_STATUS
132*433d6423SLionel Sambuc AcpiNsSearchParentTree (
133*433d6423SLionel Sambuc     UINT32                  TargetName,
134*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *Node,
135*433d6423SLionel Sambuc     ACPI_OBJECT_TYPE        Type,
136*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     **ReturnNode);
137*433d6423SLionel Sambuc 
138*433d6423SLionel Sambuc 
139*433d6423SLionel Sambuc /*******************************************************************************
140*433d6423SLionel Sambuc  *
141*433d6423SLionel Sambuc  * FUNCTION:    AcpiNsSearchOneScope
142*433d6423SLionel Sambuc  *
143*433d6423SLionel Sambuc  * PARAMETERS:  TargetName      - Ascii ACPI name to search for
144*433d6423SLionel Sambuc  *              ParentNode      - Starting node where search will begin
145*433d6423SLionel Sambuc  *              Type            - Object type to match
146*433d6423SLionel Sambuc  *              ReturnNode      - Where the matched Named obj is returned
147*433d6423SLionel Sambuc  *
148*433d6423SLionel Sambuc  * RETURN:      Status
149*433d6423SLionel Sambuc  *
150*433d6423SLionel Sambuc  * DESCRIPTION: Search a single level of the namespace. Performs a
151*433d6423SLionel Sambuc  *              simple search of the specified level, and does not add
152*433d6423SLionel Sambuc  *              entries or search parents.
153*433d6423SLionel Sambuc  *
154*433d6423SLionel Sambuc  *
155*433d6423SLionel Sambuc  *      Named object lists are built (and subsequently dumped) in the
156*433d6423SLionel Sambuc  *      order in which the names are encountered during the namespace load;
157*433d6423SLionel Sambuc  *
158*433d6423SLionel Sambuc  *      All namespace searching is linear in this implementation, but
159*433d6423SLionel Sambuc  *      could be easily modified to support any improved search
160*433d6423SLionel Sambuc  *      algorithm. However, the linear search was chosen for simplicity
161*433d6423SLionel Sambuc  *      and because the trees are small and the other interpreter
162*433d6423SLionel Sambuc  *      execution overhead is relatively high.
163*433d6423SLionel Sambuc  *
164*433d6423SLionel Sambuc  *      Note: CPU execution analysis has shown that the AML interpreter spends
165*433d6423SLionel Sambuc  *      a very small percentage of its time searching the namespace. Therefore,
166*433d6423SLionel Sambuc  *      the linear search seems to be sufficient, as there would seem to be
167*433d6423SLionel Sambuc  *      little value in improving the search.
168*433d6423SLionel Sambuc  *
169*433d6423SLionel Sambuc  ******************************************************************************/
170*433d6423SLionel Sambuc 
171*433d6423SLionel Sambuc ACPI_STATUS
172*433d6423SLionel Sambuc AcpiNsSearchOneScope (
173*433d6423SLionel Sambuc     UINT32                  TargetName,
174*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *ParentNode,
175*433d6423SLionel Sambuc     ACPI_OBJECT_TYPE        Type,
176*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     **ReturnNode)
177*433d6423SLionel Sambuc {
178*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *Node;
179*433d6423SLionel Sambuc 
180*433d6423SLionel Sambuc 
181*433d6423SLionel Sambuc     ACPI_FUNCTION_TRACE (NsSearchOneScope);
182*433d6423SLionel Sambuc 
183*433d6423SLionel Sambuc 
184*433d6423SLionel Sambuc #ifdef ACPI_DEBUG_OUTPUT
185*433d6423SLionel Sambuc     if (ACPI_LV_NAMES & AcpiDbgLevel)
186*433d6423SLionel Sambuc     {
187*433d6423SLionel Sambuc         char                *ScopeName;
188*433d6423SLionel Sambuc 
189*433d6423SLionel Sambuc         ScopeName = AcpiNsGetExternalPathname (ParentNode);
190*433d6423SLionel Sambuc         if (ScopeName)
191*433d6423SLionel Sambuc         {
192*433d6423SLionel Sambuc             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
193*433d6423SLionel Sambuc                 "Searching %s (%p) For [%4.4s] (%s)\n",
194*433d6423SLionel Sambuc                 ScopeName, ParentNode, ACPI_CAST_PTR (char, &TargetName),
195*433d6423SLionel Sambuc                 AcpiUtGetTypeName (Type)));
196*433d6423SLionel Sambuc 
197*433d6423SLionel Sambuc             ACPI_FREE (ScopeName);
198*433d6423SLionel Sambuc         }
199*433d6423SLionel Sambuc     }
200*433d6423SLionel Sambuc #endif
201*433d6423SLionel Sambuc 
202*433d6423SLionel Sambuc     /*
203*433d6423SLionel Sambuc      * Search for name at this namespace level, which is to say that we
204*433d6423SLionel Sambuc      * must search for the name among the children of this object
205*433d6423SLionel Sambuc      */
206*433d6423SLionel Sambuc     Node = ParentNode->Child;
207*433d6423SLionel Sambuc     while (Node)
208*433d6423SLionel Sambuc     {
209*433d6423SLionel Sambuc         /* Check for match against the name */
210*433d6423SLionel Sambuc 
211*433d6423SLionel Sambuc         if (Node->Name.Integer == TargetName)
212*433d6423SLionel Sambuc         {
213*433d6423SLionel Sambuc             /* Resolve a control method alias if any */
214*433d6423SLionel Sambuc 
215*433d6423SLionel Sambuc             if (AcpiNsGetType (Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS)
216*433d6423SLionel Sambuc             {
217*433d6423SLionel Sambuc                 Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
218*433d6423SLionel Sambuc             }
219*433d6423SLionel Sambuc 
220*433d6423SLionel Sambuc             /* Found matching entry */
221*433d6423SLionel Sambuc 
222*433d6423SLionel Sambuc             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
223*433d6423SLionel Sambuc                 "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n",
224*433d6423SLionel Sambuc                 ACPI_CAST_PTR (char, &TargetName),
225*433d6423SLionel Sambuc                 AcpiUtGetTypeName (Node->Type),
226*433d6423SLionel Sambuc                 Node, AcpiUtGetNodeName (ParentNode), ParentNode));
227*433d6423SLionel Sambuc 
228*433d6423SLionel Sambuc             *ReturnNode = Node;
229*433d6423SLionel Sambuc             return_ACPI_STATUS (AE_OK);
230*433d6423SLionel Sambuc         }
231*433d6423SLionel Sambuc 
232*433d6423SLionel Sambuc         /* Didn't match name, move on to the next peer object */
233*433d6423SLionel Sambuc 
234*433d6423SLionel Sambuc         Node = Node->Peer;
235*433d6423SLionel Sambuc     }
236*433d6423SLionel Sambuc 
237*433d6423SLionel Sambuc     /* Searched entire namespace level, not found */
238*433d6423SLionel Sambuc 
239*433d6423SLionel Sambuc     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
240*433d6423SLionel Sambuc         "Name [%4.4s] (%s) not found in search in scope [%4.4s] "
241*433d6423SLionel Sambuc         "%p first child %p\n",
242*433d6423SLionel Sambuc         ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type),
243*433d6423SLionel Sambuc         AcpiUtGetNodeName (ParentNode), ParentNode, ParentNode->Child));
244*433d6423SLionel Sambuc 
245*433d6423SLionel Sambuc     return_ACPI_STATUS (AE_NOT_FOUND);
246*433d6423SLionel Sambuc }
247*433d6423SLionel Sambuc 
248*433d6423SLionel Sambuc 
249*433d6423SLionel Sambuc /*******************************************************************************
250*433d6423SLionel Sambuc  *
251*433d6423SLionel Sambuc  * FUNCTION:    AcpiNsSearchParentTree
252*433d6423SLionel Sambuc  *
253*433d6423SLionel Sambuc  * PARAMETERS:  TargetName      - Ascii ACPI name to search for
254*433d6423SLionel Sambuc  *              Node            - Starting node where search will begin
255*433d6423SLionel Sambuc  *              Type            - Object type to match
256*433d6423SLionel Sambuc  *              ReturnNode      - Where the matched Node is returned
257*433d6423SLionel Sambuc  *
258*433d6423SLionel Sambuc  * RETURN:      Status
259*433d6423SLionel Sambuc  *
260*433d6423SLionel Sambuc  * DESCRIPTION: Called when a name has not been found in the current namespace
261*433d6423SLionel Sambuc  *              level. Before adding it or giving up, ACPI scope rules require
262*433d6423SLionel Sambuc  *              searching enclosing scopes in cases identified by AcpiNsLocal().
263*433d6423SLionel Sambuc  *
264*433d6423SLionel Sambuc  *              "A name is located by finding the matching name in the current
265*433d6423SLionel Sambuc  *              name space, and then in the parent name space. If the parent
266*433d6423SLionel Sambuc  *              name space does not contain the name, the search continues
267*433d6423SLionel Sambuc  *              recursively until either the name is found or the name space
268*433d6423SLionel Sambuc  *              does not have a parent (the root of the name space). This
269*433d6423SLionel Sambuc  *              indicates that the name is not found" (From ACPI Specification,
270*433d6423SLionel Sambuc  *              section 5.3)
271*433d6423SLionel Sambuc  *
272*433d6423SLionel Sambuc  ******************************************************************************/
273*433d6423SLionel Sambuc 
274*433d6423SLionel Sambuc static ACPI_STATUS
275*433d6423SLionel Sambuc AcpiNsSearchParentTree (
276*433d6423SLionel Sambuc     UINT32                  TargetName,
277*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *Node,
278*433d6423SLionel Sambuc     ACPI_OBJECT_TYPE        Type,
279*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     **ReturnNode)
280*433d6423SLionel Sambuc {
281*433d6423SLionel Sambuc     ACPI_STATUS             Status;
282*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *ParentNode;
283*433d6423SLionel Sambuc 
284*433d6423SLionel Sambuc 
285*433d6423SLionel Sambuc     ACPI_FUNCTION_TRACE (NsSearchParentTree);
286*433d6423SLionel Sambuc 
287*433d6423SLionel Sambuc 
288*433d6423SLionel Sambuc     ParentNode = Node->Parent;
289*433d6423SLionel Sambuc 
290*433d6423SLionel Sambuc     /*
291*433d6423SLionel Sambuc      * If there is no parent (i.e., we are at the root) or type is "local",
292*433d6423SLionel Sambuc      * we won't be searching the parent tree.
293*433d6423SLionel Sambuc      */
294*433d6423SLionel Sambuc     if (!ParentNode)
295*433d6423SLionel Sambuc     {
296*433d6423SLionel Sambuc         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n",
297*433d6423SLionel Sambuc             ACPI_CAST_PTR (char, &TargetName)));
298*433d6423SLionel Sambuc         return_ACPI_STATUS (AE_NOT_FOUND);
299*433d6423SLionel Sambuc     }
300*433d6423SLionel Sambuc 
301*433d6423SLionel Sambuc     if (AcpiNsLocal (Type))
302*433d6423SLionel Sambuc     {
303*433d6423SLionel Sambuc         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
304*433d6423SLionel Sambuc             "[%4.4s] type [%s] must be local to this scope (no parent search)\n",
305*433d6423SLionel Sambuc             ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type)));
306*433d6423SLionel Sambuc         return_ACPI_STATUS (AE_NOT_FOUND);
307*433d6423SLionel Sambuc     }
308*433d6423SLionel Sambuc 
309*433d6423SLionel Sambuc     /* Search the parent tree */
310*433d6423SLionel Sambuc 
311*433d6423SLionel Sambuc     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
312*433d6423SLionel Sambuc         "Searching parent [%4.4s] for [%4.4s]\n",
313*433d6423SLionel Sambuc         AcpiUtGetNodeName (ParentNode), ACPI_CAST_PTR (char, &TargetName)));
314*433d6423SLionel Sambuc 
315*433d6423SLionel Sambuc     /* Search parents until target is found or we have backed up to the root */
316*433d6423SLionel Sambuc 
317*433d6423SLionel Sambuc     while (ParentNode)
318*433d6423SLionel Sambuc     {
319*433d6423SLionel Sambuc         /*
320*433d6423SLionel Sambuc          * Search parent scope. Use TYPE_ANY because we don't care about the
321*433d6423SLionel Sambuc          * object type at this point, we only care about the existence of
322*433d6423SLionel Sambuc          * the actual name we are searching for. Typechecking comes later.
323*433d6423SLionel Sambuc          */
324*433d6423SLionel Sambuc         Status = AcpiNsSearchOneScope (
325*433d6423SLionel Sambuc                     TargetName, ParentNode, ACPI_TYPE_ANY, ReturnNode);
326*433d6423SLionel Sambuc         if (ACPI_SUCCESS (Status))
327*433d6423SLionel Sambuc         {
328*433d6423SLionel Sambuc             return_ACPI_STATUS (Status);
329*433d6423SLionel Sambuc         }
330*433d6423SLionel Sambuc 
331*433d6423SLionel Sambuc         /* Not found here, go up another level (until we reach the root) */
332*433d6423SLionel Sambuc 
333*433d6423SLionel Sambuc         ParentNode = ParentNode->Parent;
334*433d6423SLionel Sambuc     }
335*433d6423SLionel Sambuc 
336*433d6423SLionel Sambuc     /* Not found in parent tree */
337*433d6423SLionel Sambuc 
338*433d6423SLionel Sambuc     return_ACPI_STATUS (AE_NOT_FOUND);
339*433d6423SLionel Sambuc }
340*433d6423SLionel Sambuc 
341*433d6423SLionel Sambuc 
342*433d6423SLionel Sambuc /*******************************************************************************
343*433d6423SLionel Sambuc  *
344*433d6423SLionel Sambuc  * FUNCTION:    AcpiNsSearchAndEnter
345*433d6423SLionel Sambuc  *
346*433d6423SLionel Sambuc  * PARAMETERS:  TargetName          - Ascii ACPI name to search for (4 chars)
347*433d6423SLionel Sambuc  *              WalkState           - Current state of the walk
348*433d6423SLionel Sambuc  *              Node                - Starting node where search will begin
349*433d6423SLionel Sambuc  *              InterpreterMode     - Add names only in ACPI_MODE_LOAD_PASS_x.
350*433d6423SLionel Sambuc  *                                    Otherwise,search only.
351*433d6423SLionel Sambuc  *              Type                - Object type to match
352*433d6423SLionel Sambuc  *              Flags               - Flags describing the search restrictions
353*433d6423SLionel Sambuc  *              ReturnNode          - Where the Node is returned
354*433d6423SLionel Sambuc  *
355*433d6423SLionel Sambuc  * RETURN:      Status
356*433d6423SLionel Sambuc  *
357*433d6423SLionel Sambuc  * DESCRIPTION: Search for a name segment in a single namespace level,
358*433d6423SLionel Sambuc  *              optionally adding it if it is not found. If the passed
359*433d6423SLionel Sambuc  *              Type is not Any and the type previously stored in the
360*433d6423SLionel Sambuc  *              entry was Any (i.e. unknown), update the stored type.
361*433d6423SLionel Sambuc  *
362*433d6423SLionel Sambuc  *              In ACPI_IMODE_EXECUTE, search only.
363*433d6423SLionel Sambuc  *              In other modes, search and add if not found.
364*433d6423SLionel Sambuc  *
365*433d6423SLionel Sambuc  ******************************************************************************/
366*433d6423SLionel Sambuc 
367*433d6423SLionel Sambuc ACPI_STATUS
368*433d6423SLionel Sambuc AcpiNsSearchAndEnter (
369*433d6423SLionel Sambuc     UINT32                  TargetName,
370*433d6423SLionel Sambuc     ACPI_WALK_STATE         *WalkState,
371*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *Node,
372*433d6423SLionel Sambuc     ACPI_INTERPRETER_MODE   InterpreterMode,
373*433d6423SLionel Sambuc     ACPI_OBJECT_TYPE        Type,
374*433d6423SLionel Sambuc     UINT32                  Flags,
375*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     **ReturnNode)
376*433d6423SLionel Sambuc {
377*433d6423SLionel Sambuc     ACPI_STATUS             Status;
378*433d6423SLionel Sambuc     ACPI_NAMESPACE_NODE     *NewNode;
379*433d6423SLionel Sambuc 
380*433d6423SLionel Sambuc 
381*433d6423SLionel Sambuc     ACPI_FUNCTION_TRACE (NsSearchAndEnter);
382*433d6423SLionel Sambuc 
383*433d6423SLionel Sambuc 
384*433d6423SLionel Sambuc     /* Parameter validation */
385*433d6423SLionel Sambuc 
386*433d6423SLionel Sambuc     if (!Node || !TargetName || !ReturnNode)
387*433d6423SLionel Sambuc     {
388*433d6423SLionel Sambuc         ACPI_ERROR ((AE_INFO,
389*433d6423SLionel Sambuc             "Null parameter: Node %p Name 0x%X ReturnNode %p",
390*433d6423SLionel Sambuc             Node, TargetName, ReturnNode));
391*433d6423SLionel Sambuc         return_ACPI_STATUS (AE_BAD_PARAMETER);
392*433d6423SLionel Sambuc     }
393*433d6423SLionel Sambuc 
394*433d6423SLionel Sambuc     /*
395*433d6423SLionel Sambuc      * Name must consist of valid ACPI characters. We will repair the name if
396*433d6423SLionel Sambuc      * necessary because we don't want to abort because of this, but we want
397*433d6423SLionel Sambuc      * all namespace names to be printable. A warning message is appropriate.
398*433d6423SLionel Sambuc      *
399*433d6423SLionel Sambuc      * This issue came up because there are in fact machines that exhibit
400*433d6423SLionel Sambuc      * this problem, and we want to be able to enable ACPI support for them,
401*433d6423SLionel Sambuc      * even though there are a few bad names.
402*433d6423SLionel Sambuc      */
403*433d6423SLionel Sambuc     AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName));
404*433d6423SLionel Sambuc 
405*433d6423SLionel Sambuc     /* Try to find the name in the namespace level specified by the caller */
406*433d6423SLionel Sambuc 
407*433d6423SLionel Sambuc     *ReturnNode = ACPI_ENTRY_NOT_FOUND;
408*433d6423SLionel Sambuc     Status = AcpiNsSearchOneScope (TargetName, Node, Type, ReturnNode);
409*433d6423SLionel Sambuc     if (Status != AE_NOT_FOUND)
410*433d6423SLionel Sambuc     {
411*433d6423SLionel Sambuc         /*
412*433d6423SLionel Sambuc          * If we found it AND the request specifies that a find is an error,
413*433d6423SLionel Sambuc          * return the error
414*433d6423SLionel Sambuc          */
415*433d6423SLionel Sambuc         if ((Status == AE_OK) &&
416*433d6423SLionel Sambuc             (Flags & ACPI_NS_ERROR_IF_FOUND))
417*433d6423SLionel Sambuc         {
418*433d6423SLionel Sambuc             Status = AE_ALREADY_EXISTS;
419*433d6423SLionel Sambuc         }
420*433d6423SLionel Sambuc 
421*433d6423SLionel Sambuc #ifdef ACPI_ASL_COMPILER
422*433d6423SLionel Sambuc         if (*ReturnNode && (*ReturnNode)->Type == ACPI_TYPE_ANY)
423*433d6423SLionel Sambuc         {
424*433d6423SLionel Sambuc             (*ReturnNode)->Flags |= ANOBJ_IS_EXTERNAL;
425*433d6423SLionel Sambuc         }
426*433d6423SLionel Sambuc #endif
427*433d6423SLionel Sambuc 
428*433d6423SLionel Sambuc         /* Either found it or there was an error: finished either way */
429*433d6423SLionel Sambuc 
430*433d6423SLionel Sambuc         return_ACPI_STATUS (Status);
431*433d6423SLionel Sambuc     }
432*433d6423SLionel Sambuc 
433*433d6423SLionel Sambuc     /*
434*433d6423SLionel Sambuc      * The name was not found. If we are NOT performing the first pass
435*433d6423SLionel Sambuc      * (name entry) of loading the namespace, search the parent tree (all the
436*433d6423SLionel Sambuc      * way to the root if necessary.) We don't want to perform the parent
437*433d6423SLionel Sambuc      * search when the namespace is actually being loaded. We want to perform
438*433d6423SLionel Sambuc      * the search when namespace references are being resolved (load pass 2)
439*433d6423SLionel Sambuc      * and during the execution phase.
440*433d6423SLionel Sambuc      */
441*433d6423SLionel Sambuc     if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) &&
442*433d6423SLionel Sambuc         (Flags & ACPI_NS_SEARCH_PARENT))
443*433d6423SLionel Sambuc     {
444*433d6423SLionel Sambuc         /*
445*433d6423SLionel Sambuc          * Not found at this level - search parent tree according to the
446*433d6423SLionel Sambuc          * ACPI specification
447*433d6423SLionel Sambuc          */
448*433d6423SLionel Sambuc         Status = AcpiNsSearchParentTree (TargetName, Node, Type, ReturnNode);
449*433d6423SLionel Sambuc         if (ACPI_SUCCESS (Status))
450*433d6423SLionel Sambuc         {
451*433d6423SLionel Sambuc             return_ACPI_STATUS (Status);
452*433d6423SLionel Sambuc         }
453*433d6423SLionel Sambuc     }
454*433d6423SLionel Sambuc 
455*433d6423SLionel Sambuc     /* In execute mode, just search, never add names. Exit now */
456*433d6423SLionel Sambuc 
457*433d6423SLionel Sambuc     if (InterpreterMode == ACPI_IMODE_EXECUTE)
458*433d6423SLionel Sambuc     {
459*433d6423SLionel Sambuc         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
460*433d6423SLionel Sambuc             "%4.4s Not found in %p [Not adding]\n",
461*433d6423SLionel Sambuc             ACPI_CAST_PTR (char, &TargetName), Node));
462*433d6423SLionel Sambuc 
463*433d6423SLionel Sambuc         return_ACPI_STATUS (AE_NOT_FOUND);
464*433d6423SLionel Sambuc     }
465*433d6423SLionel Sambuc 
466*433d6423SLionel Sambuc     /* Create the new named object */
467*433d6423SLionel Sambuc 
468*433d6423SLionel Sambuc     NewNode = AcpiNsCreateNode (TargetName);
469*433d6423SLionel Sambuc     if (!NewNode)
470*433d6423SLionel Sambuc     {
471*433d6423SLionel Sambuc         return_ACPI_STATUS (AE_NO_MEMORY);
472*433d6423SLionel Sambuc     }
473*433d6423SLionel Sambuc 
474*433d6423SLionel Sambuc #ifdef ACPI_ASL_COMPILER
475*433d6423SLionel Sambuc 
476*433d6423SLionel Sambuc     /* Node is an object defined by an External() statement */
477*433d6423SLionel Sambuc 
478*433d6423SLionel Sambuc     if (Flags & ACPI_NS_EXTERNAL ||
479*433d6423SLionel Sambuc         (WalkState && WalkState->Opcode == AML_SCOPE_OP))
480*433d6423SLionel Sambuc     {
481*433d6423SLionel Sambuc         NewNode->Flags |= ANOBJ_IS_EXTERNAL;
482*433d6423SLionel Sambuc     }
483*433d6423SLionel Sambuc #endif
484*433d6423SLionel Sambuc 
485*433d6423SLionel Sambuc     if (Flags & ACPI_NS_TEMPORARY)
486*433d6423SLionel Sambuc     {
487*433d6423SLionel Sambuc         NewNode->Flags |= ANOBJ_TEMPORARY;
488*433d6423SLionel Sambuc     }
489*433d6423SLionel Sambuc 
490*433d6423SLionel Sambuc     /* Install the new object into the parent's list of children */
491*433d6423SLionel Sambuc 
492*433d6423SLionel Sambuc     AcpiNsInstallNode (WalkState, Node, NewNode, Type);
493*433d6423SLionel Sambuc     *ReturnNode = NewNode;
494*433d6423SLionel Sambuc     return_ACPI_STATUS (AE_OK);
495*433d6423SLionel Sambuc }
496*433d6423SLionel Sambuc 
497