17c478bd9Sstevel@tonic-gate /******************************************************************************
27c478bd9Sstevel@tonic-gate *
37c478bd9Sstevel@tonic-gate * Module Name: nswalk - Functions for walking the ACPI namespace
47c478bd9Sstevel@tonic-gate *
57c478bd9Sstevel@tonic-gate *****************************************************************************/
67c478bd9Sstevel@tonic-gate
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.
127c478bd9Sstevel@tonic-gate * All rights reserved.
137c478bd9Sstevel@tonic-gate *
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 *
11926f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross * are met:
12226f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross * notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross * without modification.
12526f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross * including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross * binary redistribution.
13026f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross * of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross * from this software without specific prior written permission.
13326f3cdf0SGordon Ross *
13426f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross * 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
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
1517c478bd9Sstevel@tonic-gate
1527c478bd9Sstevel@tonic-gate #include "acpi.h"
153aa2aa9a6SDana Myers #include "accommon.h"
1547c478bd9Sstevel@tonic-gate #include "acnamesp.h"
1557c478bd9Sstevel@tonic-gate
1567c478bd9Sstevel@tonic-gate
1577c478bd9Sstevel@tonic-gate #define _COMPONENT ACPI_NAMESPACE
1587c478bd9Sstevel@tonic-gate ACPI_MODULE_NAME ("nswalk")
1597c478bd9Sstevel@tonic-gate
1607c478bd9Sstevel@tonic-gate
1617c478bd9Sstevel@tonic-gate /*******************************************************************************
1627c478bd9Sstevel@tonic-gate *
1637c478bd9Sstevel@tonic-gate * FUNCTION: AcpiNsGetNextNode
1647c478bd9Sstevel@tonic-gate *
165aa2aa9a6SDana Myers * PARAMETERS: ParentNode - Parent node whose children we are
1667c478bd9Sstevel@tonic-gate * getting
1677c478bd9Sstevel@tonic-gate * ChildNode - Previous child that was found.
1687c478bd9Sstevel@tonic-gate * The NEXT child will be returned
1697c478bd9Sstevel@tonic-gate *
1707c478bd9Sstevel@tonic-gate * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
1717c478bd9Sstevel@tonic-gate * none is found.
1727c478bd9Sstevel@tonic-gate *
1737b1019a6SJerry Jelinek * DESCRIPTION: Return the next peer node within the namespace. If Handle
1747b1019a6SJerry Jelinek * is valid, Scope is ignored. Otherwise, the first node
1757c478bd9Sstevel@tonic-gate * within Scope is returned.
1767c478bd9Sstevel@tonic-gate *
1777c478bd9Sstevel@tonic-gate ******************************************************************************/
1787c478bd9Sstevel@tonic-gate
1797c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *
AcpiNsGetNextNode(ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)1807c478bd9Sstevel@tonic-gate AcpiNsGetNextNode (
1817c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *ParentNode,
1827c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *ChildNode)
1837c478bd9Sstevel@tonic-gate {
1847c478bd9Sstevel@tonic-gate ACPI_FUNCTION_ENTRY ();
1857c478bd9Sstevel@tonic-gate
1867c478bd9Sstevel@tonic-gate
1877c478bd9Sstevel@tonic-gate if (!ChildNode)
1887c478bd9Sstevel@tonic-gate {
1897c478bd9Sstevel@tonic-gate /* It's really the parent's _scope_ that we want */
1907c478bd9Sstevel@tonic-gate
191aa2aa9a6SDana Myers return (ParentNode->Child);
1927c478bd9Sstevel@tonic-gate }
1937c478bd9Sstevel@tonic-gate
194aa2aa9a6SDana Myers /* Otherwise just return the next peer */
195aa2aa9a6SDana Myers
196aa2aa9a6SDana Myers return (ChildNode->Peer);
197aa2aa9a6SDana Myers }
198aa2aa9a6SDana Myers
199aa2aa9a6SDana Myers
200aa2aa9a6SDana Myers /*******************************************************************************
201aa2aa9a6SDana Myers *
202aa2aa9a6SDana Myers * FUNCTION: AcpiNsGetNextNodeTyped
203aa2aa9a6SDana Myers *
204aa2aa9a6SDana Myers * PARAMETERS: Type - Type of node to be searched for
205aa2aa9a6SDana Myers * ParentNode - Parent node whose children we are
206aa2aa9a6SDana Myers * getting
207aa2aa9a6SDana Myers * ChildNode - Previous child that was found.
208aa2aa9a6SDana Myers * The NEXT child will be returned
209aa2aa9a6SDana Myers *
210aa2aa9a6SDana Myers * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if
211aa2aa9a6SDana Myers * none is found.
212aa2aa9a6SDana Myers *
2137b1019a6SJerry Jelinek * DESCRIPTION: Return the next peer node within the namespace. If Handle
2147b1019a6SJerry Jelinek * is valid, Scope is ignored. Otherwise, the first node
215aa2aa9a6SDana Myers * within Scope is returned.
216aa2aa9a6SDana Myers *
217aa2aa9a6SDana Myers ******************************************************************************/
218aa2aa9a6SDana Myers
219aa2aa9a6SDana Myers ACPI_NAMESPACE_NODE *
AcpiNsGetNextNodeTyped(ACPI_OBJECT_TYPE Type,ACPI_NAMESPACE_NODE * ParentNode,ACPI_NAMESPACE_NODE * ChildNode)220aa2aa9a6SDana Myers AcpiNsGetNextNodeTyped (
221aa2aa9a6SDana Myers ACPI_OBJECT_TYPE Type,
222aa2aa9a6SDana Myers ACPI_NAMESPACE_NODE *ParentNode,
223aa2aa9a6SDana Myers ACPI_NAMESPACE_NODE *ChildNode)
224aa2aa9a6SDana Myers {
225aa2aa9a6SDana Myers ACPI_NAMESPACE_NODE *NextNode = NULL;
226aa2aa9a6SDana Myers
227aa2aa9a6SDana Myers
228aa2aa9a6SDana Myers ACPI_FUNCTION_ENTRY ();
229aa2aa9a6SDana Myers
230aa2aa9a6SDana Myers
231aa2aa9a6SDana Myers NextNode = AcpiNsGetNextNode (ParentNode, ChildNode);
232aa2aa9a6SDana Myers
2337c478bd9Sstevel@tonic-gate /* If any type is OK, we are done */
2347c478bd9Sstevel@tonic-gate
2357c478bd9Sstevel@tonic-gate if (Type == ACPI_TYPE_ANY)
2367c478bd9Sstevel@tonic-gate {
2377c478bd9Sstevel@tonic-gate /* NextNode is NULL if we are at the end-of-list */
2387c478bd9Sstevel@tonic-gate
2397c478bd9Sstevel@tonic-gate return (NextNode);
2407c478bd9Sstevel@tonic-gate }
2417c478bd9Sstevel@tonic-gate
2427c478bd9Sstevel@tonic-gate /* Must search for the node -- but within this scope only */
2437c478bd9Sstevel@tonic-gate
2447c478bd9Sstevel@tonic-gate while (NextNode)
2457c478bd9Sstevel@tonic-gate {
2467c478bd9Sstevel@tonic-gate /* If type matches, we are done */
2477c478bd9Sstevel@tonic-gate
2487c478bd9Sstevel@tonic-gate if (NextNode->Type == Type)
2497c478bd9Sstevel@tonic-gate {
2507c478bd9Sstevel@tonic-gate return (NextNode);
2517c478bd9Sstevel@tonic-gate }
2527c478bd9Sstevel@tonic-gate
25326f3cdf0SGordon Ross /* Otherwise, move on to the next peer node */
2547c478bd9Sstevel@tonic-gate
25526f3cdf0SGordon Ross NextNode = NextNode->Peer;
2567c478bd9Sstevel@tonic-gate }
2577c478bd9Sstevel@tonic-gate
2587c478bd9Sstevel@tonic-gate /* Not found */
2597c478bd9Sstevel@tonic-gate
2607c478bd9Sstevel@tonic-gate return (NULL);
2617c478bd9Sstevel@tonic-gate }
2627c478bd9Sstevel@tonic-gate
2637c478bd9Sstevel@tonic-gate
2647c478bd9Sstevel@tonic-gate /*******************************************************************************
2657c478bd9Sstevel@tonic-gate *
2667c478bd9Sstevel@tonic-gate * FUNCTION: AcpiNsWalkNamespace
2677c478bd9Sstevel@tonic-gate *
2687c478bd9Sstevel@tonic-gate * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for
2697c478bd9Sstevel@tonic-gate * StartNode - Handle in namespace where search begins
2707c478bd9Sstevel@tonic-gate * MaxDepth - Depth to which search is to reach
271db2bae30SDana Myers * Flags - Whether to unlock the NS before invoking
2727c478bd9Sstevel@tonic-gate * the callback routine
2737b1019a6SJerry Jelinek * DescendingCallback - Called during tree descent
27457190917SDana Myers * when an object of "Type" is found
2757b1019a6SJerry Jelinek * AscendingCallback - Called during tree ascent
27657190917SDana Myers * when an object of "Type" is found
27757190917SDana Myers * Context - Passed to user function(s) above
27857190917SDana Myers * ReturnValue - from the UserFunction if terminated
27957190917SDana Myers * early. Otherwise, returns NULL.
2807c478bd9Sstevel@tonic-gate * RETURNS: Status
2817c478bd9Sstevel@tonic-gate *
2827c478bd9Sstevel@tonic-gate * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
2837c478bd9Sstevel@tonic-gate * starting (and ending) at the node specified by StartHandle.
28457190917SDana Myers * The callback function is called whenever a node that matches
28557190917SDana Myers * the type parameter is found. If the callback function returns
286aa2aa9a6SDana Myers * a non-zero value, the search is terminated immediately and
287aa2aa9a6SDana Myers * this value is returned to the caller.
2887c478bd9Sstevel@tonic-gate *
2897c478bd9Sstevel@tonic-gate * The point of this procedure is to provide a generic namespace
2907c478bd9Sstevel@tonic-gate * walk routine that can be called from multiple places to
29157190917SDana Myers * provide multiple services; the callback function(s) can be
29257190917SDana Myers * tailored to each task, whether it is a print function,
29357190917SDana Myers * a compare function, etc.
2947c478bd9Sstevel@tonic-gate *
2957c478bd9Sstevel@tonic-gate ******************************************************************************/
2967c478bd9Sstevel@tonic-gate
2977c478bd9Sstevel@tonic-gate 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)2987c478bd9Sstevel@tonic-gate AcpiNsWalkNamespace (
2997c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE Type,
3007c478bd9Sstevel@tonic-gate ACPI_HANDLE StartNode,
3017c478bd9Sstevel@tonic-gate UINT32 MaxDepth,
302db2bae30SDana Myers UINT32 Flags,
3037b1019a6SJerry Jelinek ACPI_WALK_CALLBACK DescendingCallback,
3047b1019a6SJerry Jelinek ACPI_WALK_CALLBACK AscendingCallback,
3057c478bd9Sstevel@tonic-gate void *Context,
3067c478bd9Sstevel@tonic-gate void **ReturnValue)
3077c478bd9Sstevel@tonic-gate {
3087c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
3097c478bd9Sstevel@tonic-gate ACPI_STATUS MutexStatus;
3107c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *ChildNode;
3117c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *ParentNode;
3127c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE ChildType;
3137c478bd9Sstevel@tonic-gate UINT32 Level;
31457190917SDana Myers BOOLEAN NodePreviouslyVisited = FALSE;
3157c478bd9Sstevel@tonic-gate
3167c478bd9Sstevel@tonic-gate
31727f7c583Smyers ACPI_FUNCTION_TRACE (NsWalkNamespace);
3187c478bd9Sstevel@tonic-gate
3197c478bd9Sstevel@tonic-gate
3207c478bd9Sstevel@tonic-gate /* Special case for the namespace Root Node */
3217c478bd9Sstevel@tonic-gate
3227c478bd9Sstevel@tonic-gate if (StartNode == ACPI_ROOT_OBJECT)
3237c478bd9Sstevel@tonic-gate {
3247c478bd9Sstevel@tonic-gate StartNode = AcpiGbl_RootNode;
3257c478bd9Sstevel@tonic-gate }
3267c478bd9Sstevel@tonic-gate
3277c478bd9Sstevel@tonic-gate /* Null child means "get first node" */
3287c478bd9Sstevel@tonic-gate
3297b1019a6SJerry Jelinek ParentNode = StartNode;
3307b1019a6SJerry Jelinek ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
3317b1019a6SJerry Jelinek ChildType = ACPI_TYPE_ANY;
3327b1019a6SJerry Jelinek Level = 1;
3337c478bd9Sstevel@tonic-gate
3347c478bd9Sstevel@tonic-gate /*
3357c478bd9Sstevel@tonic-gate * Traverse the tree of nodes until we bubble back up to where we
3367c478bd9Sstevel@tonic-gate * started. When Level is zero, the loop is done because we have
3377c478bd9Sstevel@tonic-gate * bubbled up to (and passed) the original parent handle (StartEntry)
3387c478bd9Sstevel@tonic-gate */
33957190917SDana Myers while (Level > 0 && ChildNode)
3407c478bd9Sstevel@tonic-gate {
3417c478bd9Sstevel@tonic-gate Status = AE_OK;
34257190917SDana Myers
34357190917SDana Myers /* Found next child, get the type if we are not searching for ANY */
34457190917SDana Myers
34557190917SDana Myers if (Type != ACPI_TYPE_ANY)
34657190917SDana Myers {
34757190917SDana Myers ChildType = ChildNode->Type;
34857190917SDana Myers }
34957190917SDana Myers
35057190917SDana Myers /*
35157190917SDana Myers * Ignore all temporary namespace nodes (created during control
35257190917SDana Myers * method execution) unless told otherwise. These temporary nodes
35357190917SDana Myers * can cause a race condition because they can be deleted during
35457190917SDana Myers * the execution of the user function (if the namespace is
35557190917SDana Myers * unlocked before invocation of the user function.) Only the
35657190917SDana Myers * debugger namespace dump will examine the temporary nodes.
35757190917SDana Myers */
35857190917SDana Myers if ((ChildNode->Flags & ANOBJ_TEMPORARY) &&
35957190917SDana Myers !(Flags & ACPI_NS_WALK_TEMP_NODES))
3607c478bd9Sstevel@tonic-gate {
36157190917SDana Myers Status = AE_CTRL_DEPTH;
36257190917SDana Myers }
363db2bae30SDana Myers
36457190917SDana Myers /* Type must match requested type */
36557190917SDana Myers
36657190917SDana Myers else if (ChildType == Type)
36757190917SDana Myers {
36857190917SDana Myers /*
36957190917SDana Myers * Found a matching node, invoke the user callback function.
37057190917SDana Myers * Unlock the namespace if flag is set.
37157190917SDana Myers */
37257190917SDana Myers if (Flags & ACPI_NS_WALK_UNLOCK)
3737c478bd9Sstevel@tonic-gate {
37457190917SDana Myers MutexStatus = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
37557190917SDana Myers if (ACPI_FAILURE (MutexStatus))
37657190917SDana Myers {
37757190917SDana Myers return_ACPI_STATUS (MutexStatus);
37857190917SDana Myers }
3797c478bd9Sstevel@tonic-gate }
3807c478bd9Sstevel@tonic-gate
381db2bae30SDana Myers /*
3827b1019a6SJerry Jelinek * Invoke the user function, either descending, ascending,
38357190917SDana Myers * or both.
384db2bae30SDana Myers */
38557190917SDana Myers if (!NodePreviouslyVisited)
386db2bae30SDana Myers {
3877b1019a6SJerry Jelinek if (DescendingCallback)
38857190917SDana Myers {
3897b1019a6SJerry Jelinek Status = DescendingCallback (ChildNode, Level,
3907b1019a6SJerry Jelinek Context, ReturnValue);
39157190917SDana Myers }
392db2bae30SDana Myers }
39357190917SDana Myers else
3947c478bd9Sstevel@tonic-gate {
3957b1019a6SJerry Jelinek if (AscendingCallback)
3967c478bd9Sstevel@tonic-gate {
3977b1019a6SJerry Jelinek Status = AscendingCallback (ChildNode, Level,
3987b1019a6SJerry Jelinek Context, ReturnValue);
3997c478bd9Sstevel@tonic-gate }
40057190917SDana Myers }
4017c478bd9Sstevel@tonic-gate
40257190917SDana Myers if (Flags & ACPI_NS_WALK_UNLOCK)
40357190917SDana Myers {
40457190917SDana Myers MutexStatus = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
40557190917SDana Myers if (ACPI_FAILURE (MutexStatus))
4067c478bd9Sstevel@tonic-gate {
40757190917SDana Myers return_ACPI_STATUS (MutexStatus);
4087c478bd9Sstevel@tonic-gate }
40957190917SDana Myers }
4107c478bd9Sstevel@tonic-gate
41157190917SDana Myers switch (Status)
41257190917SDana Myers {
41357190917SDana Myers case AE_OK:
41457190917SDana Myers case AE_CTRL_DEPTH:
4157c478bd9Sstevel@tonic-gate
41657190917SDana Myers /* Just keep going */
41757190917SDana Myers break;
4187c478bd9Sstevel@tonic-gate
41957190917SDana Myers case AE_CTRL_TERMINATE:
4207c478bd9Sstevel@tonic-gate
42157190917SDana Myers /* Exit now, with OK status */
4227c478bd9Sstevel@tonic-gate
42357190917SDana Myers return_ACPI_STATUS (AE_OK);
4247c478bd9Sstevel@tonic-gate
42557190917SDana Myers default:
4267c478bd9Sstevel@tonic-gate
42757190917SDana Myers /* All others are valid exceptions */
4287c478bd9Sstevel@tonic-gate
42957190917SDana Myers return_ACPI_STATUS (Status);
4307c478bd9Sstevel@tonic-gate }
43157190917SDana Myers }
4327c478bd9Sstevel@tonic-gate
43357190917SDana Myers /*
43457190917SDana Myers * Depth first search: Attempt to go down another level in the
4357b1019a6SJerry Jelinek * namespace if we are allowed to. Don't go any further if we have
43657190917SDana Myers * reached the caller specified maximum depth or if the user
43757190917SDana Myers * function has specified that the maximum depth has been reached.
43857190917SDana Myers */
43957190917SDana Myers if (!NodePreviouslyVisited &&
44057190917SDana Myers (Level < MaxDepth) &&
44157190917SDana Myers (Status != AE_CTRL_DEPTH))
44257190917SDana Myers {
44357190917SDana Myers if (ChildNode->Child)
4447c478bd9Sstevel@tonic-gate {
44557190917SDana Myers /* There is at least one child of this node, visit it */
446db2bae30SDana Myers
44757190917SDana Myers Level++;
44857190917SDana Myers ParentNode = ChildNode;
44957190917SDana Myers ChildNode = AcpiNsGetNextNode (ParentNode, NULL);
45057190917SDana Myers continue;
4517c478bd9Sstevel@tonic-gate }
4527c478bd9Sstevel@tonic-gate }
45357190917SDana Myers
45457190917SDana Myers /* No more children, re-visit this node */
45557190917SDana Myers
45657190917SDana Myers if (!NodePreviouslyVisited)
45757190917SDana Myers {
45857190917SDana Myers NodePreviouslyVisited = TRUE;
45957190917SDana Myers continue;
46057190917SDana Myers }
46157190917SDana Myers
46257190917SDana Myers /* No more children, visit peers */
46357190917SDana Myers
46457190917SDana Myers ChildNode = AcpiNsGetNextNode (ParentNode, ChildNode);
46557190917SDana Myers if (ChildNode)
46657190917SDana Myers {
46757190917SDana Myers NodePreviouslyVisited = FALSE;
46857190917SDana Myers }
46957190917SDana Myers
47057190917SDana Myers /* No peers, re-visit parent */
47157190917SDana Myers
4727c478bd9Sstevel@tonic-gate else
4737c478bd9Sstevel@tonic-gate {
4747c478bd9Sstevel@tonic-gate /*
475db2bae30SDana Myers * No more children of this node (AcpiNsGetNextNode failed), go
476db2bae30SDana Myers * back upwards in the namespace tree to the node's parent.
4777c478bd9Sstevel@tonic-gate */
4787c478bd9Sstevel@tonic-gate Level--;
4797c478bd9Sstevel@tonic-gate ChildNode = ParentNode;
48026f3cdf0SGordon Ross ParentNode = ParentNode->Parent;
48157190917SDana Myers
48257190917SDana Myers NodePreviouslyVisited = TRUE;
4837c478bd9Sstevel@tonic-gate }
4847c478bd9Sstevel@tonic-gate }
4857c478bd9Sstevel@tonic-gate
4867c478bd9Sstevel@tonic-gate /* Complete walk, not terminated by user function */
4877c478bd9Sstevel@tonic-gate
4887c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_OK);
4897c478bd9Sstevel@tonic-gate }
490