nswalk.c revision 71867
1/****************************************************************************** 2 * 3 * Module Name: nswalk - Functions for walking the APCI namespace 4 * $Revision: 19 $ 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 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 OBJECT_TYPE_INTERNAL Type, 151 ACPI_NAMESPACE_NODE *ParentNode, 152 ACPI_NAMESPACE_NODE *ChildNode) 153{ 154 ACPI_NAMESPACE_NODE *NextNode = NULL; 155 156 157 if (!ChildNode) 158 { 159 160 /* It's really the parent's _scope_ that we want */ 161 162 if (ParentNode->Child) 163 { 164 NextNode = ParentNode->Child; 165 } 166 } 167 168 else 169 { 170 /* Start search at the NEXT object */ 171 172 NextNode = AcpiNsGetNextValidObject (ChildNode); 173 } 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 186 /* Must search for the object -- but within this scope only */ 187 188 while (NextNode) 189 { 190 /* If type matches, we are done */ 191 192 if (NextNode->Type == Type) 193 { 194 return (NextNode); 195 } 196 197 /* Otherwise, move on to the next object */ 198 199 NextNode = AcpiNsGetNextValidObject (NextNode); 200 } 201 202 203 /* Not found */ 204 205 return (NULL); 206} 207 208 209/****************************************************************************** 210 * 211 * FUNCTION: AcpiNsWalkNamespace 212 * 213 * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for 214 * StartNode - Handle in namespace where search begins 215 * MaxDepth - Depth to which search is to reach 216 * UnlockBeforeCallback- Whether to unlock the NS before invoking 217 * the callback routine 218 * UserFunction - Called when an object of "Type" is found 219 * Context - Passed to user function 220 * 221 * RETURNS Return value from the UserFunction if terminated early. 222 * Otherwise, returns NULL. 223 * 224 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, 225 * starting (and ending) at the object specified by StartHandle. 226 * The UserFunction is called whenever an object that matches 227 * the type parameter is found. If the user function returns 228 * a non-zero value, the search is terminated immediately and this 229 * value is returned to the caller. 230 * 231 * The point of this procedure is to provide a generic namespace 232 * walk routine that can be called from multiple places to 233 * provide multiple services; the User Function can be tailored 234 * to each task, whether it is a print function, a compare 235 * function, etc. 236 * 237 ******************************************************************************/ 238 239ACPI_STATUS 240AcpiNsWalkNamespace ( 241 OBJECT_TYPE_INTERNAL Type, 242 ACPI_HANDLE StartNode, 243 UINT32 MaxDepth, 244 BOOLEAN UnlockBeforeCallback, 245 WALK_CALLBACK UserFunction, 246 void *Context, 247 void **ReturnValue) 248{ 249 ACPI_STATUS Status; 250 ACPI_NAMESPACE_NODE *ChildNode; 251 ACPI_NAMESPACE_NODE *ParentNode; 252 OBJECT_TYPE_INTERNAL ChildType; 253 UINT32 Level; 254 255 256 FUNCTION_TRACE ("NsWalkNamespace"); 257 258 /* Special case for the namespace Root Node */ 259 260 if (StartNode == ACPI_ROOT_OBJECT) 261 { 262 StartNode = AcpiGbl_RootNode; 263 } 264 265 266 /* Null child means "get first object" */ 267 268 ParentNode = StartNode; 269 ChildNode = 0; 270 ChildType = ACPI_TYPE_ANY; 271 Level = 1; 272 273 /* 274 * Traverse the tree of objects until we bubble back up to where we 275 * started. When Level is zero, the loop is done because we have 276 * bubbled up to (and passed) the original parent handle (StartEntry) 277 */ 278 279 while (Level > 0) 280 { 281 /* 282 * Get the next typed object in this scope. Null returned 283 * if not found 284 */ 285 286 Status = AE_OK; 287 ChildNode = AcpiNsGetNextObject (ACPI_TYPE_ANY, 288 ParentNode, 289 ChildNode); 290 291 if (ChildNode) 292 { 293 /* 294 * Found an object, Get the type if we are not 295 * searching for ANY 296 */ 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 310 if (UnlockBeforeCallback) 311 { 312 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 313 } 314 315 Status = UserFunction (ChildNode, Level, 316 Context, ReturnValue); 317 318 if (UnlockBeforeCallback) 319 { 320 AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 321 } 322 323 switch (Status) 324 { 325 case AE_OK: 326 case AE_CTRL_DEPTH: 327 /* Just keep going */ 328 break; 329 330 case AE_CTRL_TERMINATE: 331 /* Exit now, with OK status */ 332 return_ACPI_STATUS (AE_OK); 333 break; 334 335 default: 336 /* All others are valid exceptions */ 337 return_ACPI_STATUS (Status); 338 break; 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 351 if ((Level < MaxDepth) && (Status != AE_CTRL_DEPTH)) 352 { 353 if (AcpiNsGetNextObject (ACPI_TYPE_ANY, 354 ChildNode, 0)) 355 { 356 /* 357 * There is at least one child of this 358 * object, visit the object 359 */ 360 Level++; 361 ParentNode = ChildNode; 362 ChildNode = 0; 363 } 364 } 365 } 366 367 else 368 { 369 /* 370 * No more children in this object (AcpiNsGetNextObject 371 * failed), go back upwards in the namespace tree to 372 * the object's parent. 373 */ 374 Level--; 375 ChildNode = ParentNode; 376 ParentNode = AcpiNsGetParentObject (ParentNode); 377 } 378 } 379 380 /* Complete walk, not terminated by user function */ 381 return_ACPI_STATUS (AE_OK); 382} 383 384 385