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