1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts *
3bc36eafdSMike Gerdts * Module Name: nswalk - Functions for walking the ACPI namespace
4bc36eafdSMike Gerdts *
5bc36eafdSMike Gerdts *****************************************************************************/
6bc36eafdSMike Gerdts
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts * All rights reserved.
13bc36eafdSMike Gerdts *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119bc36eafdSMike Gerdts * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts * are met:
122bc36eafdSMike Gerdts * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts * notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts * without modification.
125bc36eafdSMike Gerdts * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts * substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts * ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts * including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts * binary redistribution.
130bc36eafdSMike Gerdts * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts * of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts * from this software without specific prior written permission.
133bc36eafdSMike Gerdts *
134*35786f68SRobert Mustacchi * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135*35786f68SRobert Mustacchi * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137*35786f68SRobert Mustacchi * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147bc36eafdSMike Gerdts * GNU General Public License ("GPL") version 2 as published by the Free
148bc36eafdSMike Gerdts * Software Foundation.
149bc36eafdSMike Gerdts *
150*35786f68SRobert Mustacchi *****************************************************************************/
151bc36eafdSMike Gerdts
152bc36eafdSMike Gerdts #include "acpi.h"
153bc36eafdSMike Gerdts #include "accommon.h"
154bc36eafdSMike Gerdts #include "acnamesp.h"
155bc36eafdSMike Gerdts
156bc36eafdSMike Gerdts
157bc36eafdSMike Gerdts #define _COMPONENT ACPI_NAMESPACE
158bc36eafdSMike Gerdts ACPI_MODULE_NAME ("nswalk")
159bc36eafdSMike Gerdts
160bc36eafdSMike Gerdts
161bc36eafdSMike Gerdts /*******************************************************************************
162bc36eafdSMike Gerdts *
163bc36eafdSMike Gerdts * FUNCTION: AcpiNsGetNextNode
164bc36eafdSMike Gerdts *
165bc36eafdSMike Gerdts * PARAMETERS: ParentNode - Parent node whose children we are
166bc36eafdSMike Gerdts * getting
167bc36eafdSMike Gerdts * ChildNode - Previous child that was found.
168bc36eafdSMike Gerdts * The NEXT child will be returned
169bc36eafdSMike Gerdts *
170bc36eafdSMike Gerdts * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
171bc36eafdSMike Gerdts * none is found.
172bc36eafdSMike Gerdts *
173bc36eafdSMike Gerdts * DESCRIPTION: Return the next peer node within the namespace. If Handle
174bc36eafdSMike Gerdts * is valid, Scope is ignored. Otherwise, the first node
175bc36eafdSMike Gerdts * within Scope is returned.
176bc36eafdSMike Gerdts *
177bc36eafdSMike Gerdts ******************************************************************************/
178bc36eafdSMike Gerdts
179bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *
AcpiNsGetNextNode(ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)180bc36eafdSMike Gerdts AcpiNsGetNextNode (
181bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ParentNode,
182bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ChildNode)
183bc36eafdSMike Gerdts {
184bc36eafdSMike Gerdts ACPI_FUNCTION_ENTRY ();
185bc36eafdSMike Gerdts
186bc36eafdSMike Gerdts
187bc36eafdSMike Gerdts if (!ChildNode)
188bc36eafdSMike Gerdts {
189bc36eafdSMike Gerdts /* It's really the parent's _scope_ that we want */
190bc36eafdSMike Gerdts
191bc36eafdSMike Gerdts return (ParentNode->Child);
192bc36eafdSMike Gerdts }
193bc36eafdSMike Gerdts
194bc36eafdSMike Gerdts /* Otherwise just return the next peer */
195bc36eafdSMike Gerdts
196bc36eafdSMike Gerdts return (ChildNode->Peer);
197bc36eafdSMike Gerdts }
198bc36eafdSMike Gerdts
199bc36eafdSMike Gerdts
200bc36eafdSMike Gerdts /*******************************************************************************
201bc36eafdSMike Gerdts *
202bc36eafdSMike Gerdts * FUNCTION: AcpiNsGetNextNodeTyped
203bc36eafdSMike Gerdts *
204bc36eafdSMike Gerdts * PARAMETERS: Type - Type of node to be searched for
205bc36eafdSMike Gerdts * ParentNode - Parent node whose children we are
206bc36eafdSMike Gerdts * getting
207bc36eafdSMike Gerdts * ChildNode - Previous child that was found.
208bc36eafdSMike Gerdts * The NEXT child will be returned
209bc36eafdSMike Gerdts *
210bc36eafdSMike Gerdts * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
211bc36eafdSMike Gerdts * none is found.
212bc36eafdSMike Gerdts *
213bc36eafdSMike Gerdts * DESCRIPTION: Return the next peer node within the namespace. If Handle
214bc36eafdSMike Gerdts * is valid, Scope is ignored. Otherwise, the first node
215bc36eafdSMike Gerdts * within Scope is returned.
216bc36eafdSMike Gerdts *
217bc36eafdSMike Gerdts ******************************************************************************/
218bc36eafdSMike Gerdts
219bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *
AcpiNsGetNextNodeTyped(ACPI_OBJECT_TYPE Type,ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)220bc36eafdSMike Gerdts AcpiNsGetNextNodeTyped (
221bc36eafdSMike Gerdts ACPI_OBJECT_TYPE Type,
222bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ParentNode,
223bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ChildNode)
224bc36eafdSMike Gerdts {
225bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *NextNode = NULL;
226bc36eafdSMike Gerdts
227bc36eafdSMike Gerdts
228bc36eafdSMike Gerdts ACPI_FUNCTION_ENTRY ();
229bc36eafdSMike Gerdts
230bc36eafdSMike Gerdts
231bc36eafdSMike Gerdts NextNode = AcpiNsGetNextNode (ParentNode, ChildNode);
232bc36eafdSMike Gerdts
233bc36eafdSMike Gerdts /* If any type is OK, we are done */
234bc36eafdSMike Gerdts
235bc36eafdSMike Gerdts if (Type == ACPI_TYPE_ANY)
236bc36eafdSMike Gerdts {
237bc36eafdSMike Gerdts /* NextNode is NULL if we are at the end-of-list */
238bc36eafdSMike Gerdts
239bc36eafdSMike Gerdts return (NextNode);
240bc36eafdSMike Gerdts }
241bc36eafdSMike Gerdts
242bc36eafdSMike Gerdts /* Must search for the node -- but within this scope only */
243bc36eafdSMike Gerdts
244bc36eafdSMike Gerdts while (NextNode)
245bc36eafdSMike Gerdts {
246bc36eafdSMike Gerdts /* If type matches, we are done */
247bc36eafdSMike Gerdts
248bc36eafdSMike Gerdts if (NextNode->Type == Type)
249bc36eafdSMike Gerdts {
250bc36eafdSMike Gerdts return (NextNode);
251bc36eafdSMike Gerdts }
252bc36eafdSMike Gerdts
253bc36eafdSMike Gerdts /* Otherwise, move on to the next peer node */
254bc36eafdSMike Gerdts
255bc36eafdSMike Gerdts NextNode = NextNode->Peer;
256bc36eafdSMike Gerdts }
257bc36eafdSMike Gerdts
258bc36eafdSMike Gerdts /* Not found */
259bc36eafdSMike Gerdts
260bc36eafdSMike Gerdts return (NULL);
261bc36eafdSMike Gerdts }
262bc36eafdSMike Gerdts
263bc36eafdSMike Gerdts
264bc36eafdSMike Gerdts /*******************************************************************************
265bc36eafdSMike Gerdts *
266bc36eafdSMike Gerdts * FUNCTION: AcpiNsWalkNamespace
267bc36eafdSMike Gerdts *
268bc36eafdSMike Gerdts * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for
269bc36eafdSMike Gerdts * StartNode - Handle in namespace where search begins
270bc36eafdSMike Gerdts * MaxDepth - Depth to which search is to reach
271bc36eafdSMike Gerdts * Flags - Whether to unlock the NS before invoking
272bc36eafdSMike Gerdts * the callback routine
273bc36eafdSMike Gerdts * DescendingCallback - Called during tree descent
274bc36eafdSMike Gerdts * when an object of "Type" is found
275bc36eafdSMike Gerdts * AscendingCallback - Called during tree ascent
276bc36eafdSMike Gerdts * when an object of "Type" is found
277bc36eafdSMike Gerdts * Context - Passed to user function(s) above
278bc36eafdSMike Gerdts * ReturnValue - from the UserFunction if terminated
279bc36eafdSMike Gerdts * early. Otherwise, returns NULL.
280bc36eafdSMike Gerdts * RETURNS: Status
281bc36eafdSMike Gerdts *
282bc36eafdSMike Gerdts * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
283bc36eafdSMike Gerdts * starting (and ending) at the node specified by StartHandle.
284bc36eafdSMike Gerdts * The callback function is called whenever a node that matches
285bc36eafdSMike Gerdts * the type parameter is found. If the callback function returns
286bc36eafdSMike Gerdts * a non-zero value, the search is terminated immediately and
287bc36eafdSMike Gerdts * this value is returned to the caller.
288bc36eafdSMike Gerdts *
289bc36eafdSMike Gerdts * The point of this procedure is to provide a generic namespace
290bc36eafdSMike Gerdts * walk routine that can be called from multiple places to
291bc36eafdSMike Gerdts * provide multiple services; the callback function(s) can be
292bc36eafdSMike Gerdts * tailored to each task, whether it is a print function,
293bc36eafdSMike Gerdts * a compare function, etc.
294bc36eafdSMike Gerdts *
295bc36eafdSMike Gerdts ******************************************************************************/
296bc36eafdSMike Gerdts
297bc36eafdSMike Gerdts ACPI_STATUS
AcpiNsWalkNamespace(ACPI_OBJECT_TYPE Type,ACPI_HANDLE StartNode,UINT32 MaxDepth,UINT32 Flags,ACPI_WALK_CALLBACK DescendingCallback,ACPI_WALK_CALLBACK AscendingCallback,void * Context,void ** ReturnValue)298bc36eafdSMike Gerdts AcpiNsWalkNamespace (
299bc36eafdSMike Gerdts ACPI_OBJECT_TYPE Type,
300bc36eafdSMike Gerdts ACPI_HANDLE StartNode,
301bc36eafdSMike Gerdts UINT32 MaxDepth,
302bc36eafdSMike Gerdts UINT32 Flags,
303bc36eafdSMike Gerdts ACPI_WALK_CALLBACK DescendingCallback,
304bc36eafdSMike Gerdts ACPI_WALK_CALLBACK AscendingCallback,
305bc36eafdSMike Gerdts void *Context,
306bc36eafdSMike Gerdts void **ReturnValue)
307bc36eafdSMike Gerdts {
308bc36eafdSMike Gerdts ACPI_STATUS Status;
309bc36eafdSMike Gerdts ACPI_STATUS MutexStatus;
310bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ChildNode;
311bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *ParentNode;
312bc36eafdSMike Gerdts ACPI_OBJECT_TYPE ChildType;
313bc36eafdSMike Gerdts UINT32 Level;
314bc36eafdSMike Gerdts BOOLEAN NodePreviouslyVisited = FALSE;
315bc36eafdSMike Gerdts
316bc36eafdSMike Gerdts
317bc36eafdSMike Gerdts ACPI_FUNCTION_TRACE (NsWalkNamespace);
318bc36eafdSMike Gerdts
319bc36eafdSMike Gerdts
320bc36eafdSMike Gerdts /* Special case for the namespace Root Node */
321bc36eafdSMike Gerdts
322bc36eafdSMike Gerdts if (StartNode == ACPI_ROOT_OBJECT)
323bc36eafdSMike Gerdts {
324bc36eafdSMike Gerdts StartNode = AcpiGbl_RootNode;
325bc36eafdSMike Gerdts }
326bc36eafdSMike Gerdts
327bc36eafdSMike Gerdts /* Null child means "get first node" */
328bc36eafdSMike Gerdts
329bc36eafdSMike Gerdts ParentNode = StartNode;
330bc36eafdSMike Gerdts ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
331bc36eafdSMike Gerdts ChildType = ACPI_TYPE_ANY;
332bc36eafdSMike Gerdts Level = 1;
333bc36eafdSMike Gerdts
334bc36eafdSMike Gerdts /*
335bc36eafdSMike Gerdts * Traverse the tree of nodes until we bubble back up to where we
336bc36eafdSMike Gerdts * started. When Level is zero, the loop is done because we have
337bc36eafdSMike Gerdts * bubbled up to (and passed) the original parent handle (StartEntry)
338bc36eafdSMike Gerdts */
339bc36eafdSMike Gerdts while (Level > 0 && ChildNode)
340bc36eafdSMike Gerdts {
341bc36eafdSMike Gerdts Status = AE_OK;
342bc36eafdSMike Gerdts
343bc36eafdSMike Gerdts /* Found next child, get the type if we are not searching for ANY */
344bc36eafdSMike Gerdts
345bc36eafdSMike Gerdts if (Type != ACPI_TYPE_ANY)
346bc36eafdSMike Gerdts {
347bc36eafdSMike Gerdts ChildType = ChildNode->Type;
348bc36eafdSMike Gerdts }
349bc36eafdSMike Gerdts
350bc36eafdSMike Gerdts /*
351bc36eafdSMike Gerdts * Ignore all temporary namespace nodes (created during control
352bc36eafdSMike Gerdts * method execution) unless told otherwise. These temporary nodes
353bc36eafdSMike Gerdts * can cause a race condition because they can be deleted during
354bc36eafdSMike Gerdts * the execution of the user function (if the namespace is
355bc36eafdSMike Gerdts * unlocked before invocation of the user function.) Only the
356bc36eafdSMike Gerdts * debugger namespace dump will examine the temporary nodes.
357bc36eafdSMike Gerdts */
358bc36eafdSMike Gerdts if ((ChildNode->Flags & ANOBJ_TEMPORARY) &&
359bc36eafdSMike Gerdts !(Flags & ACPI_NS_WALK_TEMP_NODES))
360bc36eafdSMike Gerdts {
361bc36eafdSMike Gerdts Status = AE_CTRL_DEPTH;
362bc36eafdSMike Gerdts }
363bc36eafdSMike Gerdts
364bc36eafdSMike Gerdts /* Type must match requested type */
365bc36eafdSMike Gerdts
366bc36eafdSMike Gerdts else if (ChildType == Type)
367bc36eafdSMike Gerdts {
368bc36eafdSMike Gerdts /*
369bc36eafdSMike Gerdts * Found a matching node, invoke the user callback function.
370bc36eafdSMike Gerdts * Unlock the namespace if flag is set.
371bc36eafdSMike Gerdts */
372bc36eafdSMike Gerdts if (Flags & ACPI_NS_WALK_UNLOCK)
373bc36eafdSMike Gerdts {
374bc36eafdSMike Gerdts MutexStatus = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
375bc36eafdSMike Gerdts if (ACPI_FAILURE (MutexStatus))
376bc36eafdSMike Gerdts {
377bc36eafdSMike Gerdts return_ACPI_STATUS (MutexStatus);
378bc36eafdSMike Gerdts }
379bc36eafdSMike Gerdts }
380bc36eafdSMike Gerdts
381bc36eafdSMike Gerdts /*
382bc36eafdSMike Gerdts * Invoke the user function, either descending, ascending,
383bc36eafdSMike Gerdts * or both.
384bc36eafdSMike Gerdts */
385bc36eafdSMike Gerdts if (!NodePreviouslyVisited)
386bc36eafdSMike Gerdts {
387bc36eafdSMike Gerdts if (DescendingCallback)
388bc36eafdSMike Gerdts {
389bc36eafdSMike Gerdts Status = DescendingCallback (ChildNode, Level,
390bc36eafdSMike Gerdts Context, ReturnValue);
391bc36eafdSMike Gerdts }
392bc36eafdSMike Gerdts }
393bc36eafdSMike Gerdts else
394bc36eafdSMike Gerdts {
395bc36eafdSMike Gerdts if (AscendingCallback)
396bc36eafdSMike Gerdts {
397bc36eafdSMike Gerdts Status = AscendingCallback (ChildNode, Level,
398bc36eafdSMike Gerdts Context, ReturnValue);
399bc36eafdSMike Gerdts }
400bc36eafdSMike Gerdts }
401bc36eafdSMike Gerdts
402bc36eafdSMike Gerdts if (Flags & ACPI_NS_WALK_UNLOCK)
403bc36eafdSMike Gerdts {
404bc36eafdSMike Gerdts MutexStatus = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
405bc36eafdSMike Gerdts if (ACPI_FAILURE (MutexStatus))
406bc36eafdSMike Gerdts {
407bc36eafdSMike Gerdts return_ACPI_STATUS (MutexStatus);
408bc36eafdSMike Gerdts }
409bc36eafdSMike Gerdts }
410bc36eafdSMike Gerdts
411bc36eafdSMike Gerdts switch (Status)
412bc36eafdSMike Gerdts {
413bc36eafdSMike Gerdts case AE_OK:
414bc36eafdSMike Gerdts case AE_CTRL_DEPTH:
415bc36eafdSMike Gerdts
416bc36eafdSMike Gerdts /* Just keep going */
417bc36eafdSMike Gerdts break;
418bc36eafdSMike Gerdts
419bc36eafdSMike Gerdts case AE_CTRL_TERMINATE:
420bc36eafdSMike Gerdts
421bc36eafdSMike Gerdts /* Exit now, with OK status */
422bc36eafdSMike Gerdts
423bc36eafdSMike Gerdts return_ACPI_STATUS (AE_OK);
424bc36eafdSMike Gerdts
425bc36eafdSMike Gerdts default:
426bc36eafdSMike Gerdts
427bc36eafdSMike Gerdts /* All others are valid exceptions */
428bc36eafdSMike Gerdts
429bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
430bc36eafdSMike Gerdts }
431bc36eafdSMike Gerdts }
432bc36eafdSMike Gerdts
433bc36eafdSMike Gerdts /*
434bc36eafdSMike Gerdts * Depth first search: Attempt to go down another level in the
435bc36eafdSMike Gerdts * namespace if we are allowed to. Don't go any further if we have
436bc36eafdSMike Gerdts * reached the caller specified maximum depth or if the user
437bc36eafdSMike Gerdts * function has specified that the maximum depth has been reached.
438bc36eafdSMike Gerdts */
439bc36eafdSMike Gerdts if (!NodePreviouslyVisited &&
440bc36eafdSMike Gerdts (Level < MaxDepth) &&
441bc36eafdSMike Gerdts (Status != AE_CTRL_DEPTH))
442bc36eafdSMike Gerdts {
443bc36eafdSMike Gerdts if (ChildNode->Child)
444bc36eafdSMike Gerdts {
445bc36eafdSMike Gerdts /* There is at least one child of this node, visit it */
446bc36eafdSMike Gerdts
447bc36eafdSMike Gerdts Level++;
448bc36eafdSMike Gerdts ParentNode = ChildNode;
449bc36eafdSMike Gerdts ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
450bc36eafdSMike Gerdts continue;
451bc36eafdSMike Gerdts }
452bc36eafdSMike Gerdts }
453bc36eafdSMike Gerdts
454bc36eafdSMike Gerdts /* No more children, re-visit this node */
455bc36eafdSMike Gerdts
456bc36eafdSMike Gerdts if (!NodePreviouslyVisited)
457bc36eafdSMike Gerdts {
458bc36eafdSMike Gerdts NodePreviouslyVisited = TRUE;
459bc36eafdSMike Gerdts continue;
460bc36eafdSMike Gerdts }
461bc36eafdSMike Gerdts
462bc36eafdSMike Gerdts /* No more children, visit peers */
463bc36eafdSMike Gerdts
464bc36eafdSMike Gerdts ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
465bc36eafdSMike Gerdts if (ChildNode)
466bc36eafdSMike Gerdts {
467bc36eafdSMike Gerdts NodePreviouslyVisited = FALSE;
468bc36eafdSMike Gerdts }
469bc36eafdSMike Gerdts
470bc36eafdSMike Gerdts /* No peers, re-visit parent */
471bc36eafdSMike Gerdts
472bc36eafdSMike Gerdts else
473bc36eafdSMike Gerdts {
474bc36eafdSMike Gerdts /*
475bc36eafdSMike Gerdts * No more children of this node (AcpiNsGetNextNode failed), go
476bc36eafdSMike Gerdts * back upwards in the namespace tree to the node's parent.
477bc36eafdSMike Gerdts */
478bc36eafdSMike Gerdts Level--;
479bc36eafdSMike Gerdts ChildNode = ParentNode;
480bc36eafdSMike Gerdts ParentNode = ParentNode->Parent;
481bc36eafdSMike Gerdts
482bc36eafdSMike Gerdts NodePreviouslyVisited = TRUE;
483bc36eafdSMike Gerdts }
484bc36eafdSMike Gerdts }
485bc36eafdSMike Gerdts
486bc36eafdSMike Gerdts /* Complete walk, not terminated by user function */
487bc36eafdSMike Gerdts
488bc36eafdSMike Gerdts return_ACPI_STATUS (AE_OK);
489bc36eafdSMike Gerdts }
490