nswalk.c revision 83174
1/****************************************************************************** 2 * 3 * Module Name: nswalk - Functions for walking the ACPI namespace 4 * $Revision: 24 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 "acpi.h" 121#include "acinterp.h" 122#include "acnamesp.h" 123 124 125#define _COMPONENT ACPI_NAMESPACE 126 MODULE_NAME ("nswalk") 127 128 129/**************************************************************************** 130 * 131 * FUNCTION: AcpiGetNextObject 132 * 133 * PARAMETERS: Type - Type of object to be searched for 134 * Parent - Parent object whose children we are 135 * getting 136 * LastChild - Previous child that was found. 137 * The NEXT child will be returned 138 * 139 * RETURN: ACPI_NAMESPACE_NODE - Pointer to the NEXT child or NULL if 140 * none is found. 141 * 142 * DESCRIPTION: Return the next peer object within the namespace. If Handle 143 * is valid, Scope is ignored. Otherwise, the first object 144 * within Scope is returned. 145 * 146 ****************************************************************************/ 147 148ACPI_NAMESPACE_NODE * 149AcpiNsGetNextObject ( 150 ACPI_OBJECT_TYPE8 Type, 151 ACPI_NAMESPACE_NODE *ParentNode, 152 ACPI_NAMESPACE_NODE *ChildNode) 153{ 154 ACPI_NAMESPACE_NODE *NextNode = NULL; 155 156 157 FUNCTION_ENTRY (); 158 159 160 if (!ChildNode) 161 { 162 /* It's really the parent's _scope_ that we want */ 163 164 if (ParentNode->Child) 165 { 166 NextNode = ParentNode->Child; 167 } 168 } 169 170 else 171 { 172 /* Start search at the NEXT object */ 173 174 NextNode = AcpiNsGetNextValidObject (ChildNode); 175 } 176 177 178 /* If any type is OK, we are done */ 179 180 if (Type == ACPI_TYPE_ANY) 181 { 182 /* NextNode is NULL if we are at the end-of-list */ 183 184 return (NextNode); 185 } 186 187 188 /* Must search for the object -- but within this scope only */ 189 190 while (NextNode) 191 { 192 /* If type matches, we are done */ 193 194 if (NextNode->Type == Type) 195 { 196 return (NextNode); 197 } 198 199 /* Otherwise, move on to the next object */ 200 201 NextNode = AcpiNsGetNextValidObject (NextNode); 202 } 203 204 205 /* Not found */ 206 207 return (NULL); 208} 209 210 211/****************************************************************************** 212 * 213 * FUNCTION: AcpiNsWalkNamespace 214 * 215 * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for 216 * StartNode - Handle in namespace where search begins 217 * MaxDepth - Depth to which search is to reach 218 * UnlockBeforeCallback- Whether to unlock the NS before invoking 219 * the callback routine 220 * UserFunction - Called when an object of "Type" is found 221 * Context - Passed to user function 222 * 223 * RETURNS Return value from the UserFunction if terminated early. 224 * Otherwise, returns NULL. 225 * 226 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, 227 * starting (and ending) at the object specified by StartHandle. 228 * The UserFunction is called whenever an object that matches 229 * the type parameter is found. If the user function returns 230 * a non-zero value, the search is terminated immediately and this 231 * value is returned to the caller. 232 * 233 * The point of this procedure is to provide a generic namespace 234 * walk routine that can be called from multiple places to 235 * provide multiple services; the User Function can be tailored 236 * to each task, whether it is a print function, a compare 237 * function, etc. 238 * 239 ******************************************************************************/ 240 241ACPI_STATUS 242AcpiNsWalkNamespace ( 243 ACPI_OBJECT_TYPE8 Type, 244 ACPI_HANDLE StartNode, 245 UINT32 MaxDepth, 246 BOOLEAN UnlockBeforeCallback, 247 ACPI_WALK_CALLBACK UserFunction, 248 void *Context, 249 void **ReturnValue) 250{ 251 ACPI_STATUS Status; 252 ACPI_NAMESPACE_NODE *ChildNode; 253 ACPI_NAMESPACE_NODE *ParentNode; 254 ACPI_OBJECT_TYPE8 ChildType; 255 UINT32 Level; 256 257 258 FUNCTION_TRACE ("NsWalkNamespace"); 259 260 261 /* Special case for the namespace Root Node */ 262 263 if (StartNode == ACPI_ROOT_OBJECT) 264 { 265 StartNode = AcpiGbl_RootNode; 266 } 267 268 269 /* Null child means "get first object" */ 270 271 ParentNode = StartNode; 272 ChildNode = 0; 273 ChildType = ACPI_TYPE_ANY; 274 Level = 1; 275 276 /* 277 * Traverse the tree of objects until we bubble back up to where we 278 * started. When Level is zero, the loop is done because we have 279 * bubbled up to (and passed) the original parent handle (StartEntry) 280 */ 281 while (Level > 0) 282 { 283 /* 284 * Get the next typed object in this scope. Null returned 285 * if not found 286 */ 287 Status = AE_OK; 288 ChildNode = AcpiNsGetNextObject (ACPI_TYPE_ANY, 289 ParentNode, 290 ChildNode); 291 292 if (ChildNode) 293 { 294 /* 295 * Found an object, Get the type if we are not 296 * searching for ANY 297 */ 298 if (Type != ACPI_TYPE_ANY) 299 { 300 ChildType = ChildNode->Type; 301 } 302 303 if (ChildType == Type) 304 { 305 /* 306 * Found a matching object, invoke the user 307 * callback function 308 */ 309 if (UnlockBeforeCallback) 310 { 311 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 312 } 313 314 Status = UserFunction (ChildNode, Level, 315 Context, ReturnValue); 316 317 if (UnlockBeforeCallback) 318 { 319 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 320 } 321 322 switch (Status) 323 { 324 case AE_OK: 325 case AE_CTRL_DEPTH: 326 327 /* Just keep going */ 328 break; 329 330 case AE_CTRL_TERMINATE: 331 332 /* Exit now, with OK status */ 333 334 return_ACPI_STATUS (AE_OK); 335 break; 336 337 default: 338 339 /* All others are valid exceptions */ 340 341 return_ACPI_STATUS (Status); 342 break; 343 } 344 } 345 346 /* 347 * Depth first search: 348 * Attempt to go down another level in the namespace 349 * if we are allowed to. Don't go any further if we 350 * have reached the caller specified maximum depth 351 * or if the user function has specified that the 352 * maximum depth has been reached. 353 */ 354 if ((Level < MaxDepth) && (Status != AE_CTRL_DEPTH)) 355 { 356 if (AcpiNsGetNextObject (ACPI_TYPE_ANY, 357 ChildNode, 0)) 358 { 359 /* 360 * There is at least one child of this 361 * object, visit the object 362 */ 363 Level++; 364 ParentNode = ChildNode; 365 ChildNode = 0; 366 } 367 } 368 } 369 370 else 371 { 372 /* 373 * No more children in this object (AcpiNsGetNextObject 374 * failed), go back upwards in the namespace tree to 375 * the object's parent. 376 */ 377 Level--; 378 ChildNode = ParentNode; 379 ParentNode = AcpiNsGetParentObject (ParentNode); 380 } 381 } 382 383 /* Complete walk, not terminated by user function */ 384 385 return_ACPI_STATUS (AE_OK); 386} 387 388 389