10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner *
30d02842fSSascha Wildner * Module Name: nswalk - Functions for walking the ACPI namespace
40d02842fSSascha Wildner *
50d02842fSSascha Wildner *****************************************************************************/
60d02842fSSascha Wildner
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner *
9b4315fc7SSascha Wildner * 1. Copyright Notice
10b4315fc7SSascha Wildner *
11*383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
120d02842fSSascha Wildner * All rights reserved.
130d02842fSSascha Wildner *
14b4315fc7SSascha Wildner * 2. License
15b4315fc7SSascha Wildner *
16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner * property rights.
20b4315fc7SSascha Wildner *
21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner *
28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner *
37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner * conditions are met:
39b4315fc7SSascha Wildner *
40b4315fc7SSascha Wildner * 3. Conditions
41b4315fc7SSascha Wildner *
42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner *
54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner * make.
65b4315fc7SSascha Wildner *
66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner * distribution.
71b4315fc7SSascha Wildner *
72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner * Intel Code.
74b4315fc7SSascha Wildner *
75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner * without prior written authorization from Intel.
79b4315fc7SSascha Wildner *
80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner *
82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner *
90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner * LIMITED REMEDY.
98b4315fc7SSascha Wildner *
99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner * such license, approval or letter.
113b4315fc7SSascha Wildner *
114b4315fc7SSascha Wildner *****************************************************************************
115b4315fc7SSascha Wildner *
116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner * following license:
118b4315fc7SSascha Wildner *
1190d02842fSSascha Wildner * Redistribution and use in source and binary forms, with or without
1200d02842fSSascha Wildner * modification, are permitted provided that the following conditions
1210d02842fSSascha Wildner * are met:
1220d02842fSSascha Wildner * 1. Redistributions of source code must retain the above copyright
1230d02842fSSascha Wildner * notice, this list of conditions, and the following disclaimer,
1240d02842fSSascha Wildner * without modification.
1250d02842fSSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d02842fSSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below
1270d02842fSSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon
1280d02842fSSascha Wildner * including a substantially similar Disclaimer requirement for further
1290d02842fSSascha Wildner * binary redistribution.
1300d02842fSSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names
1310d02842fSSascha Wildner * of any contributors may be used to endorse or promote products derived
1320d02842fSSascha Wildner * from this software without specific prior written permission.
1330d02842fSSascha Wildner *
134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner *
146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
1470d02842fSSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free
1480d02842fSSascha Wildner * Software Foundation.
1490d02842fSSascha Wildner *
150b4315fc7SSascha Wildner *****************************************************************************/
1510d02842fSSascha Wildner
1520d02842fSSascha Wildner #include "acpi.h"
1530d02842fSSascha Wildner #include "accommon.h"
1540d02842fSSascha Wildner #include "acnamesp.h"
1550d02842fSSascha Wildner
1560d02842fSSascha Wildner
1570d02842fSSascha Wildner #define _COMPONENT ACPI_NAMESPACE
1580d02842fSSascha Wildner ACPI_MODULE_NAME ("nswalk")
1590d02842fSSascha Wildner
1600d02842fSSascha Wildner
1610d02842fSSascha Wildner /*******************************************************************************
1620d02842fSSascha Wildner *
1630d02842fSSascha Wildner * FUNCTION: AcpiNsGetNextNode
1640d02842fSSascha Wildner *
1650d02842fSSascha Wildner * PARAMETERS: ParentNode - Parent node whose children we are
1660d02842fSSascha Wildner * getting
1670d02842fSSascha Wildner * ChildNode - Previous child that was found.
1680d02842fSSascha Wildner * The NEXT child will be returned
1690d02842fSSascha Wildner *
1700d02842fSSascha Wildner * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
1710d02842fSSascha Wildner * none is found.
1720d02842fSSascha Wildner *
1730d02842fSSascha Wildner * DESCRIPTION: Return the next peer node within the namespace. If Handle
1740d02842fSSascha Wildner * is valid, Scope is ignored. Otherwise, the first node
1750d02842fSSascha Wildner * within Scope is returned.
1760d02842fSSascha Wildner *
1770d02842fSSascha Wildner ******************************************************************************/
1780d02842fSSascha Wildner
1790d02842fSSascha Wildner ACPI_NAMESPACE_NODE *
AcpiNsGetNextNode(ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)1800d02842fSSascha Wildner AcpiNsGetNextNode (
1810d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ParentNode,
1820d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ChildNode)
1830d02842fSSascha Wildner {
1840d02842fSSascha Wildner ACPI_FUNCTION_ENTRY ();
1850d02842fSSascha Wildner
1860d02842fSSascha Wildner
1870d02842fSSascha Wildner if (!ChildNode)
1880d02842fSSascha Wildner {
1890d02842fSSascha Wildner /* It's really the parent's _scope_ that we want */
1900d02842fSSascha Wildner
1910d02842fSSascha Wildner return (ParentNode->Child);
1920d02842fSSascha Wildner }
1930d02842fSSascha Wildner
1940d02842fSSascha Wildner /* Otherwise just return the next peer */
1950d02842fSSascha Wildner
1960d02842fSSascha Wildner return (ChildNode->Peer);
1970d02842fSSascha Wildner }
1980d02842fSSascha Wildner
1990d02842fSSascha Wildner
2000d02842fSSascha Wildner /*******************************************************************************
2010d02842fSSascha Wildner *
2020d02842fSSascha Wildner * FUNCTION: AcpiNsGetNextNodeTyped
2030d02842fSSascha Wildner *
2040d02842fSSascha Wildner * PARAMETERS: Type - Type of node to be searched for
2050d02842fSSascha Wildner * ParentNode - Parent node whose children we are
2060d02842fSSascha Wildner * getting
2070d02842fSSascha Wildner * ChildNode - Previous child that was found.
2080d02842fSSascha Wildner * The NEXT child will be returned
2090d02842fSSascha Wildner *
2100d02842fSSascha Wildner * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
2110d02842fSSascha Wildner * none is found.
2120d02842fSSascha Wildner *
2130d02842fSSascha Wildner * DESCRIPTION: Return the next peer node within the namespace. If Handle
2140d02842fSSascha Wildner * is valid, Scope is ignored. Otherwise, the first node
2150d02842fSSascha Wildner * within Scope is returned.
2160d02842fSSascha Wildner *
2170d02842fSSascha Wildner ******************************************************************************/
2180d02842fSSascha Wildner
2190d02842fSSascha Wildner ACPI_NAMESPACE_NODE *
AcpiNsGetNextNodeTyped(ACPI_OBJECT_TYPE Type,ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)2200d02842fSSascha Wildner AcpiNsGetNextNodeTyped (
2210d02842fSSascha Wildner ACPI_OBJECT_TYPE Type,
2220d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ParentNode,
2230d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ChildNode)
2240d02842fSSascha Wildner {
2250d02842fSSascha Wildner ACPI_NAMESPACE_NODE *NextNode = NULL;
2260d02842fSSascha Wildner
2270d02842fSSascha Wildner
2280d02842fSSascha Wildner ACPI_FUNCTION_ENTRY ();
2290d02842fSSascha Wildner
2300d02842fSSascha Wildner
2310d02842fSSascha Wildner NextNode = AcpiNsGetNextNode (ParentNode, ChildNode);
2320d02842fSSascha Wildner
2330d02842fSSascha Wildner /* If any type is OK, we are done */
2340d02842fSSascha Wildner
2350d02842fSSascha Wildner if (Type == ACPI_TYPE_ANY)
2360d02842fSSascha Wildner {
2370d02842fSSascha Wildner /* NextNode is NULL if we are at the end-of-list */
2380d02842fSSascha Wildner
2390d02842fSSascha Wildner return (NextNode);
2400d02842fSSascha Wildner }
2410d02842fSSascha Wildner
2420d02842fSSascha Wildner /* Must search for the node -- but within this scope only */
2430d02842fSSascha Wildner
2440d02842fSSascha Wildner while (NextNode)
2450d02842fSSascha Wildner {
2460d02842fSSascha Wildner /* If type matches, we are done */
2470d02842fSSascha Wildner
2480d02842fSSascha Wildner if (NextNode->Type == Type)
2490d02842fSSascha Wildner {
2500d02842fSSascha Wildner return (NextNode);
2510d02842fSSascha Wildner }
2520d02842fSSascha Wildner
2530d02842fSSascha Wildner /* Otherwise, move on to the next peer node */
2540d02842fSSascha Wildner
2550d02842fSSascha Wildner NextNode = NextNode->Peer;
2560d02842fSSascha Wildner }
2570d02842fSSascha Wildner
2580d02842fSSascha Wildner /* Not found */
2590d02842fSSascha Wildner
2600d02842fSSascha Wildner return (NULL);
2610d02842fSSascha Wildner }
2620d02842fSSascha Wildner
2630d02842fSSascha Wildner
2640d02842fSSascha Wildner /*******************************************************************************
2650d02842fSSascha Wildner *
2660d02842fSSascha Wildner * FUNCTION: AcpiNsWalkNamespace
2670d02842fSSascha Wildner *
2680d02842fSSascha Wildner * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for
2690d02842fSSascha Wildner * StartNode - Handle in namespace where search begins
2700d02842fSSascha Wildner * MaxDepth - Depth to which search is to reach
2710d02842fSSascha Wildner * Flags - Whether to unlock the NS before invoking
2720d02842fSSascha Wildner * the callback routine
2730d02842fSSascha Wildner * DescendingCallback - Called during tree descent
2740d02842fSSascha Wildner * when an object of "Type" is found
2750d02842fSSascha Wildner * AscendingCallback - Called during tree ascent
2760d02842fSSascha Wildner * when an object of "Type" is found
2770d02842fSSascha Wildner * Context - Passed to user function(s) above
2780d02842fSSascha Wildner * ReturnValue - from the UserFunction if terminated
2790d02842fSSascha Wildner * early. Otherwise, returns NULL.
2800d02842fSSascha Wildner * RETURNS: Status
2810d02842fSSascha Wildner *
2820d02842fSSascha Wildner * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
2830d02842fSSascha Wildner * starting (and ending) at the node specified by StartHandle.
2840d02842fSSascha Wildner * The callback function is called whenever a node that matches
2850d02842fSSascha Wildner * the type parameter is found. If the callback function returns
2860d02842fSSascha Wildner * a non-zero value, the search is terminated immediately and
2870d02842fSSascha Wildner * this value is returned to the caller.
2880d02842fSSascha Wildner *
2890d02842fSSascha Wildner * The point of this procedure is to provide a generic namespace
2900d02842fSSascha Wildner * walk routine that can be called from multiple places to
2910d02842fSSascha Wildner * provide multiple services; the callback function(s) can be
2920d02842fSSascha Wildner * tailored to each task, whether it is a print function,
2930d02842fSSascha Wildner * a compare function, etc.
2940d02842fSSascha Wildner *
2950d02842fSSascha Wildner ******************************************************************************/
2960d02842fSSascha Wildner
2970d02842fSSascha Wildner 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)2980d02842fSSascha Wildner AcpiNsWalkNamespace (
2990d02842fSSascha Wildner ACPI_OBJECT_TYPE Type,
3000d02842fSSascha Wildner ACPI_HANDLE StartNode,
3010d02842fSSascha Wildner UINT32 MaxDepth,
3020d02842fSSascha Wildner UINT32 Flags,
3030d02842fSSascha Wildner ACPI_WALK_CALLBACK DescendingCallback,
3040d02842fSSascha Wildner ACPI_WALK_CALLBACK AscendingCallback,
3050d02842fSSascha Wildner void *Context,
3060d02842fSSascha Wildner void **ReturnValue)
3070d02842fSSascha Wildner {
3080d02842fSSascha Wildner ACPI_STATUS Status;
3090d02842fSSascha Wildner ACPI_STATUS MutexStatus;
3100d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ChildNode;
3110d02842fSSascha Wildner ACPI_NAMESPACE_NODE *ParentNode;
3120d02842fSSascha Wildner ACPI_OBJECT_TYPE ChildType;
3130d02842fSSascha Wildner UINT32 Level;
3140d02842fSSascha Wildner BOOLEAN NodePreviouslyVisited = FALSE;
3150d02842fSSascha Wildner
3160d02842fSSascha Wildner
3170d02842fSSascha Wildner ACPI_FUNCTION_TRACE (NsWalkNamespace);
3180d02842fSSascha Wildner
3190d02842fSSascha Wildner
3200d02842fSSascha Wildner /* Special case for the namespace Root Node */
3210d02842fSSascha Wildner
3220d02842fSSascha Wildner if (StartNode == ACPI_ROOT_OBJECT)
3230d02842fSSascha Wildner {
3240d02842fSSascha Wildner StartNode = AcpiGbl_RootNode;
3250d02842fSSascha Wildner }
3260d02842fSSascha Wildner
3270d02842fSSascha Wildner /* Null child means "get first node" */
3280d02842fSSascha Wildner
3290d02842fSSascha Wildner ParentNode = StartNode;
3300d02842fSSascha Wildner ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
3310d02842fSSascha Wildner ChildType = ACPI_TYPE_ANY;
3320d02842fSSascha Wildner Level = 1;
3330d02842fSSascha Wildner
3340d02842fSSascha Wildner /*
3350d02842fSSascha Wildner * Traverse the tree of nodes until we bubble back up to where we
3360d02842fSSascha Wildner * started. When Level is zero, the loop is done because we have
3370d02842fSSascha Wildner * bubbled up to (and passed) the original parent handle (StartEntry)
3380d02842fSSascha Wildner */
3390d02842fSSascha Wildner while (Level > 0 && ChildNode)
3400d02842fSSascha Wildner {
3410d02842fSSascha Wildner Status = AE_OK;
3420d02842fSSascha Wildner
3430d02842fSSascha Wildner /* Found next child, get the type if we are not searching for ANY */
3440d02842fSSascha Wildner
3450d02842fSSascha Wildner if (Type != ACPI_TYPE_ANY)
3460d02842fSSascha Wildner {
3470d02842fSSascha Wildner ChildType = ChildNode->Type;
3480d02842fSSascha Wildner }
3490d02842fSSascha Wildner
3500d02842fSSascha Wildner /*
3510d02842fSSascha Wildner * Ignore all temporary namespace nodes (created during control
3520d02842fSSascha Wildner * method execution) unless told otherwise. These temporary nodes
3530d02842fSSascha Wildner * can cause a race condition because they can be deleted during
3540d02842fSSascha Wildner * the execution of the user function (if the namespace is
3550d02842fSSascha Wildner * unlocked before invocation of the user function.) Only the
3560d02842fSSascha Wildner * debugger namespace dump will examine the temporary nodes.
3570d02842fSSascha Wildner */
3580d02842fSSascha Wildner if ((ChildNode->Flags & ANOBJ_TEMPORARY) &&
3590d02842fSSascha Wildner !(Flags & ACPI_NS_WALK_TEMP_NODES))
3600d02842fSSascha Wildner {
3610d02842fSSascha Wildner Status = AE_CTRL_DEPTH;
3620d02842fSSascha Wildner }
3630d02842fSSascha Wildner
3640d02842fSSascha Wildner /* Type must match requested type */
3650d02842fSSascha Wildner
3660d02842fSSascha Wildner else if (ChildType == Type)
3670d02842fSSascha Wildner {
3680d02842fSSascha Wildner /*
3690d02842fSSascha Wildner * Found a matching node, invoke the user callback function.
3700d02842fSSascha Wildner * Unlock the namespace if flag is set.
3710d02842fSSascha Wildner */
3720d02842fSSascha Wildner if (Flags & ACPI_NS_WALK_UNLOCK)
3730d02842fSSascha Wildner {
3740d02842fSSascha Wildner MutexStatus = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
3750d02842fSSascha Wildner if (ACPI_FAILURE (MutexStatus))
3760d02842fSSascha Wildner {
3770d02842fSSascha Wildner return_ACPI_STATUS (MutexStatus);
3780d02842fSSascha Wildner }
3790d02842fSSascha Wildner }
3800d02842fSSascha Wildner
3810d02842fSSascha Wildner /*
3820d02842fSSascha Wildner * Invoke the user function, either descending, ascending,
3830d02842fSSascha Wildner * or both.
3840d02842fSSascha Wildner */
3850d02842fSSascha Wildner if (!NodePreviouslyVisited)
3860d02842fSSascha Wildner {
3870d02842fSSascha Wildner if (DescendingCallback)
3880d02842fSSascha Wildner {
3890d02842fSSascha Wildner Status = DescendingCallback (ChildNode, Level,
3900d02842fSSascha Wildner Context, ReturnValue);
3910d02842fSSascha Wildner }
3920d02842fSSascha Wildner }
3930d02842fSSascha Wildner else
3940d02842fSSascha Wildner {
3950d02842fSSascha Wildner if (AscendingCallback)
3960d02842fSSascha Wildner {
3970d02842fSSascha Wildner Status = AscendingCallback (ChildNode, Level,
3980d02842fSSascha Wildner Context, ReturnValue);
3990d02842fSSascha Wildner }
4000d02842fSSascha Wildner }
4010d02842fSSascha Wildner
4020d02842fSSascha Wildner if (Flags & ACPI_NS_WALK_UNLOCK)
4030d02842fSSascha Wildner {
4040d02842fSSascha Wildner MutexStatus = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
4050d02842fSSascha Wildner if (ACPI_FAILURE (MutexStatus))
4060d02842fSSascha Wildner {
4070d02842fSSascha Wildner return_ACPI_STATUS (MutexStatus);
4080d02842fSSascha Wildner }
4090d02842fSSascha Wildner }
4100d02842fSSascha Wildner
4110d02842fSSascha Wildner switch (Status)
4120d02842fSSascha Wildner {
4130d02842fSSascha Wildner case AE_OK:
4140d02842fSSascha Wildner case AE_CTRL_DEPTH:
4150d02842fSSascha Wildner
4160d02842fSSascha Wildner /* Just keep going */
4170d02842fSSascha Wildner break;
4180d02842fSSascha Wildner
4190d02842fSSascha Wildner case AE_CTRL_TERMINATE:
4200d02842fSSascha Wildner
4210d02842fSSascha Wildner /* Exit now, with OK status */
4220d02842fSSascha Wildner
4230d02842fSSascha Wildner return_ACPI_STATUS (AE_OK);
4240d02842fSSascha Wildner
4250d02842fSSascha Wildner default:
4260d02842fSSascha Wildner
4270d02842fSSascha Wildner /* All others are valid exceptions */
4280d02842fSSascha Wildner
4290d02842fSSascha Wildner return_ACPI_STATUS (Status);
4300d02842fSSascha Wildner }
4310d02842fSSascha Wildner }
4320d02842fSSascha Wildner
4330d02842fSSascha Wildner /*
4340d02842fSSascha Wildner * Depth first search: Attempt to go down another level in the
4350d02842fSSascha Wildner * namespace if we are allowed to. Don't go any further if we have
4360d02842fSSascha Wildner * reached the caller specified maximum depth or if the user
4370d02842fSSascha Wildner * function has specified that the maximum depth has been reached.
4380d02842fSSascha Wildner */
4390d02842fSSascha Wildner if (!NodePreviouslyVisited &&
4400d02842fSSascha Wildner (Level < MaxDepth) &&
4410d02842fSSascha Wildner (Status != AE_CTRL_DEPTH))
4420d02842fSSascha Wildner {
4430d02842fSSascha Wildner if (ChildNode->Child)
4440d02842fSSascha Wildner {
4450d02842fSSascha Wildner /* There is at least one child of this node, visit it */
4460d02842fSSascha Wildner
4470d02842fSSascha Wildner Level++;
4480d02842fSSascha Wildner ParentNode = ChildNode;
4490d02842fSSascha Wildner ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
4500d02842fSSascha Wildner continue;
4510d02842fSSascha Wildner }
4520d02842fSSascha Wildner }
4530d02842fSSascha Wildner
4540d02842fSSascha Wildner /* No more children, re-visit this node */
4550d02842fSSascha Wildner
4560d02842fSSascha Wildner if (!NodePreviouslyVisited)
4570d02842fSSascha Wildner {
4580d02842fSSascha Wildner NodePreviouslyVisited = TRUE;
4590d02842fSSascha Wildner continue;
4600d02842fSSascha Wildner }
4610d02842fSSascha Wildner
4620d02842fSSascha Wildner /* No more children, visit peers */
4630d02842fSSascha Wildner
4640d02842fSSascha Wildner ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
4650d02842fSSascha Wildner if (ChildNode)
4660d02842fSSascha Wildner {
4670d02842fSSascha Wildner NodePreviouslyVisited = FALSE;
4680d02842fSSascha Wildner }
4690d02842fSSascha Wildner
4700d02842fSSascha Wildner /* No peers, re-visit parent */
4710d02842fSSascha Wildner
4720d02842fSSascha Wildner else
4730d02842fSSascha Wildner {
4740d02842fSSascha Wildner /*
4750d02842fSSascha Wildner * No more children of this node (AcpiNsGetNextNode failed), go
4760d02842fSSascha Wildner * back upwards in the namespace tree to the node's parent.
4770d02842fSSascha Wildner */
4780d02842fSSascha Wildner Level--;
4790d02842fSSascha Wildner ChildNode = ParentNode;
4800d02842fSSascha Wildner ParentNode = ParentNode->Parent;
4810d02842fSSascha Wildner
4820d02842fSSascha Wildner NodePreviouslyVisited = TRUE;
4830d02842fSSascha Wildner }
4840d02842fSSascha Wildner }
4850d02842fSSascha Wildner
4860d02842fSSascha Wildner /* Complete walk, not terminated by user function */
4870d02842fSSascha Wildner
4880d02842fSSascha Wildner return_ACPI_STATUS (AE_OK);
4890d02842fSSascha Wildner }
490