nswalk.c revision 114237
1203954Srdivacky/****************************************************************************** 2203954Srdivacky * 3203954Srdivacky * Module Name: nswalk - Functions for walking the ACPI namespace 4203954Srdivacky * $Revision: 34 $ 5203954Srdivacky * 6203954Srdivacky *****************************************************************************/ 7203954Srdivacky 8203954Srdivacky/****************************************************************************** 9203954Srdivacky * 10203954Srdivacky * 1. Copyright Notice 11203954Srdivacky * 12203954Srdivacky * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 13203954Srdivacky * All rights reserved. 14203954Srdivacky * 15203954Srdivacky * 2. License 16203954Srdivacky * 17203954Srdivacky * 2.1. This is your license from Intel Corp. under its intellectual property 18203954Srdivacky * rights. You may have additional license terms from the party that provided 19203954Srdivacky * you this software, covering your right to use that party's intellectual 20203954Srdivacky * property rights. 21203954Srdivacky * 22203954Srdivacky * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23203954Srdivacky * copy of the source code appearing in this file ("Covered Code") an 24203954Srdivacky * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25203954Srdivacky * base code distributed originally by Intel ("Original Intel Code") to copy, 26203954Srdivacky * make derivatives, distribute, use and display any portion of the Covered 27203954Srdivacky * Code in any form, with the right to sublicense such rights; and 28203954Srdivacky * 29203954Srdivacky * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30203954Srdivacky * license (with the right to sublicense), under only those claims of Intel 31203954Srdivacky * patents that are infringed by the Original Intel Code, to make, use, sell, 32203954Srdivacky * offer to sell, and import the Covered Code and derivative works thereof 33203954Srdivacky * solely to the minimum extent necessary to exercise the above copyright 34203954Srdivacky * license, and in no event shall the patent license extend to any additions 35203954Srdivacky * to or modifications of the Original Intel Code. No other license or right 36203954Srdivacky * is granted directly or by implication, estoppel or otherwise; 37203954Srdivacky * 38203954Srdivacky * The above copyright and patent license is granted only if the following 39203954Srdivacky * conditions are met: 40203954Srdivacky * 41203954Srdivacky * 3. Conditions 42203954Srdivacky * 43203954Srdivacky * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44203954Srdivacky * Redistribution of source code of any substantial portion of the Covered 45203954Srdivacky * Code or modification with rights to further distribute source must include 46203954Srdivacky * the above Copyright Notice, the above License, this list of Conditions, 47203954Srdivacky * and the following Disclaimer and Export Compliance provision. In addition, 48203954Srdivacky * Licensee must cause all Covered Code to which Licensee contributes to 49203954Srdivacky * contain a file documenting the changes Licensee made to create that Covered 50203954Srdivacky * Code and the date of any change. Licensee must include in that file the 51203954Srdivacky * documentation of any changes made by any predecessor Licensee. Licensee 52203954Srdivacky * must include a prominent statement that the modification is derived, 53203954Srdivacky * directly or indirectly, from Original Intel Code. 54203954Srdivacky * 55203954Srdivacky * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56203954Srdivacky * Redistribution of source code of any substantial portion of the Covered 57203954Srdivacky * Code or modification without rights to further distribute source must 58203954Srdivacky * include the following Disclaimer and Export Compliance provision in the 59203954Srdivacky * documentation and/or other materials provided with distribution. In 60203954Srdivacky * addition, Licensee may not authorize further sublicense of source of any 61203954Srdivacky * portion of the Covered Code, and must include terms to the effect that the 62203954Srdivacky * license from Licensee to its licensee is limited to the intellectual 63203954Srdivacky * property embodied in the software Licensee provides to its licensee, and 64203954Srdivacky * not to intellectual property embodied in modifications its licensee may 65203954Srdivacky * make. 66203954Srdivacky * 67203954Srdivacky * 3.3. Redistribution of Executable. Redistribution in executable form of any 68203954Srdivacky * substantial portion of the Covered Code or modification must reproduce the 69203954Srdivacky * above Copyright Notice, and the following Disclaimer and Export Compliance 70203954Srdivacky * provision in the documentation and/or other materials provided with the 71203954Srdivacky * distribution. 72203954Srdivacky * 73203954Srdivacky * 3.4. Intel retains all right, title, and interest in and to the Original 74203954Srdivacky * Intel Code. 75203954Srdivacky * 76203954Srdivacky * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77203954Srdivacky * Intel shall be used in advertising or otherwise to promote the sale, use or 78203954Srdivacky * other dealings in products derived from or relating to the Covered Code 79203954Srdivacky * without prior written authorization from Intel. 80203954Srdivacky * 81203954Srdivacky * 4. Disclaimer and Export Compliance 82203954Srdivacky * 83203954Srdivacky * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84203954Srdivacky * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85203954Srdivacky * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86203954Srdivacky * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87203954Srdivacky * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88203954Srdivacky * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89203954Srdivacky * PARTICULAR PURPOSE. 90203954Srdivacky * 91203954Srdivacky * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92203954Srdivacky * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93203954Srdivacky * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94203954Srdivacky * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95203954Srdivacky * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96203954Srdivacky * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97203954Srdivacky * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98203954Srdivacky * LIMITED REMEDY. 99203954Srdivacky * 100203954Srdivacky * 4.3. Licensee shall not export, either directly or indirectly, any of this 101203954Srdivacky * software or system incorporating such software without first obtaining any 102203954Srdivacky * required license or other approval from the U. S. Department of Commerce or 103203954Srdivacky * any other agency or department of the United States Government. In the 104203954Srdivacky * event Licensee exports any such software from the United States or 105203954Srdivacky * re-exports any such software from a foreign destination, Licensee shall 106203954Srdivacky * ensure that the distribution and export/re-export of the software is in 107203954Srdivacky * compliance with all laws, regulations, orders, or other restrictions of the 108203954Srdivacky * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109203954Srdivacky * any of its subsidiaries will export/re-export any technical data, process, 110203954Srdivacky * software, or service, directly or indirectly, to any country for which the 111203954Srdivacky * United States government or any agency thereof requires an export license, 112203954Srdivacky * other governmental approval, or letter of assurance, without first obtaining 113203954Srdivacky * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118#define __NSWALK_C__ 119 120#include "acpi.h" 121#include "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 147ACPI_NAMESPACE_NODE * 148AcpiNsGetNextNode ( 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 if (ParentNode->Child) 164 { 165 NextNode = ParentNode->Child; 166 } 167 } 168 169 else 170 { 171 /* Start search at the NEXT node */ 172 173 NextNode = AcpiNsGetNextValidNode (ChildNode); 174 } 175 176 /* If any type is OK, we are done */ 177 178 if (Type == ACPI_TYPE_ANY) 179 { 180 /* NextNode is NULL if we are at the end-of-list */ 181 182 return (NextNode); 183 } 184 185 /* Must search for the node -- but within this scope only */ 186 187 while (NextNode) 188 { 189 /* If type matches, we are done */ 190 191 if (NextNode->Type == Type) 192 { 193 return (NextNode); 194 } 195 196 /* Otherwise, move on to the next node */ 197 198 NextNode = AcpiNsGetNextValidNode (NextNode); 199 } 200 201 /* Not found */ 202 203 return (NULL); 204} 205 206 207/******************************************************************************* 208 * 209 * FUNCTION: AcpiNsWalkNamespace 210 * 211 * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for 212 * StartNode - Handle in namespace where search begins 213 * MaxDepth - Depth to which search is to reach 214 * UnlockBeforeCallback- Whether to unlock the NS before invoking 215 * the callback routine 216 * UserFunction - Called when an object of "Type" is found 217 * Context - Passed to user function 218 * ReturnValue - from the UserFunction if terminated early. 219 * Otherwise, returns NULL. 220 * RETURNS: Status 221 * 222 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, 223 * starting (and ending) at the node specified by StartHandle. 224 * The UserFunction is called whenever a node that matches 225 * the type parameter is found. If the user function returns 226 * a non-zero value, the search is terminated immediately and this 227 * value is returned to the caller. 228 * 229 * The point of this procedure is to provide a generic namespace 230 * walk routine that can be called from multiple places to 231 * provide multiple services; the User Function can be tailored 232 * to each task, whether it is a print function, a compare 233 * function, etc. 234 * 235 ******************************************************************************/ 236 237ACPI_STATUS 238AcpiNsWalkNamespace ( 239 ACPI_OBJECT_TYPE Type, 240 ACPI_HANDLE StartNode, 241 UINT32 MaxDepth, 242 BOOLEAN UnlockBeforeCallback, 243 ACPI_WALK_CALLBACK UserFunction, 244 void *Context, 245 void **ReturnValue) 246{ 247 ACPI_STATUS Status; 248 ACPI_NAMESPACE_NODE *ChildNode; 249 ACPI_NAMESPACE_NODE *ParentNode; 250 ACPI_OBJECT_TYPE ChildType; 251 UINT32 Level; 252 253 254 ACPI_FUNCTION_TRACE ("NsWalkNamespace"); 255 256 257 /* Special case for the namespace Root Node */ 258 259 if (StartNode == ACPI_ROOT_OBJECT) 260 { 261 StartNode = AcpiGbl_RootNode; 262 } 263 264 /* Null child means "get first node" */ 265 266 ParentNode = StartNode; 267 ChildNode = 0; 268 ChildType = ACPI_TYPE_ANY; 269 Level = 1; 270 271 /* 272 * Traverse the tree of nodes until we bubble back up to where we 273 * started. When Level is zero, the loop is done because we have 274 * bubbled up to (and passed) the original parent handle (StartEntry) 275 */ 276 while (Level > 0) 277 { 278 /* Get the next node in this scope. Null if not found */ 279 280 Status = AE_OK; 281 ChildNode = AcpiNsGetNextNode (ACPI_TYPE_ANY, ParentNode, ChildNode); 282 if (ChildNode) 283 { 284 /* 285 * Found node, Get the type if we are not 286 * searching for ANY 287 */ 288 if (Type != ACPI_TYPE_ANY) 289 { 290 ChildType = ChildNode->Type; 291 } 292 293 if (ChildType == Type) 294 { 295 /* 296 * Found a matching node, invoke the user 297 * callback function 298 */ 299 if (UnlockBeforeCallback) 300 { 301 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 302 if (ACPI_FAILURE (Status)) 303 { 304 return_ACPI_STATUS (Status); 305 } 306 } 307 308 Status = UserFunction (ChildNode, Level, 309 Context, ReturnValue); 310 311 if (UnlockBeforeCallback) 312 { 313 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 314 if (ACPI_FAILURE (Status)) 315 { 316 return_ACPI_STATUS (Status); 317 } 318 } 319 320 switch (Status) 321 { 322 case AE_OK: 323 case AE_CTRL_DEPTH: 324 325 /* Just keep going */ 326 break; 327 328 case AE_CTRL_TERMINATE: 329 330 /* Exit now, with OK status */ 331 332 return_ACPI_STATUS (AE_OK); 333 334 default: 335 336 /* All others are valid exceptions */ 337 338 return_ACPI_STATUS (Status); 339 } 340 } 341 342 /* 343 * Depth first search: 344 * Attempt to go down another level in the namespace 345 * if we are allowed to. Don't go any further if we 346 * have reached the caller specified maximum depth 347 * or if the user function has specified that the 348 * maximum depth has been reached. 349 */ 350 if ((Level < MaxDepth) && (Status != AE_CTRL_DEPTH)) 351 { 352 if (AcpiNsGetNextNode (ACPI_TYPE_ANY, ChildNode, 0)) 353 { 354 /* 355 * There is at least one child of this 356 * node, visit the onde 357 */ 358 Level++; 359 ParentNode = ChildNode; 360 ChildNode = 0; 361 } 362 } 363 } 364 else 365 { 366 /* 367 * No more children of this node (AcpiNsGetNextNode 368 * failed), go back upwards in the namespace tree to 369 * the node's parent. 370 */ 371 Level--; 372 ChildNode = ParentNode; 373 ParentNode = AcpiNsGetParentNode (ParentNode); 374 } 375 } 376 377 /* Complete walk, not terminated by user function */ 378 379 return_ACPI_STATUS (AE_OK); 380} 381 382 383