sys/contrib/dev/acpica/nswalk.c

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