1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * $Revision: 1.149 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2006, 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 #ifndef __ACNAMESP_H__ 118 #define __ACNAMESP_H__ 119 120 121 /* To search the entire name space, pass this as SearchBase */ 122 123 #define ACPI_NS_ALL ((ACPI_HANDLE)0) 124 125 /* 126 * Elements of AcpiNsProperties are bit significant 127 * and should be one-to-one with values of ACPI_OBJECT_TYPE 128 */ 129 #define ACPI_NS_NORMAL 0 130 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */ 131 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */ 132 133 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */ 134 135 #define ACPI_NS_NO_UPSEARCH 0 136 #define ACPI_NS_SEARCH_PARENT 0x01 137 #define ACPI_NS_DONT_OPEN_SCOPE 0x02 138 #define ACPI_NS_NO_PEER_SEARCH 0x04 139 #define ACPI_NS_ERROR_IF_FOUND 0x08 140 #define ACPI_NS_PREFIX_IS_SCOPE 0x10 141 #define ACPI_NS_EXTERNAL 0x20 142 143 #define ACPI_NS_WALK_UNLOCK TRUE 144 #define ACPI_NS_WALK_NO_UNLOCK FALSE 145 146 147 /* 148 * nsinit - Namespace initialization 149 */ 150 ACPI_STATUS 151 AcpiNsInitializeObjects ( 152 void); 153 154 ACPI_STATUS 155 AcpiNsInitializeDevices ( 156 void); 157 158 159 /* 160 * nsload - Namespace loading 161 */ 162 ACPI_STATUS 163 AcpiNsLoadNamespace ( 164 void); 165 166 ACPI_STATUS 167 AcpiNsLoadTable ( 168 ACPI_TABLE_DESC *TableDesc, 169 ACPI_NAMESPACE_NODE *Node); 170 171 172 /* 173 * nswalk - walk the namespace 174 */ 175 ACPI_STATUS 176 AcpiNsWalkNamespace ( 177 ACPI_OBJECT_TYPE Type, 178 ACPI_HANDLE StartObject, 179 UINT32 MaxDepth, 180 BOOLEAN UnlockBeforeCallback, 181 ACPI_WALK_CALLBACK UserFunction, 182 void *Context, 183 void **ReturnValue); 184 185 ACPI_NAMESPACE_NODE * 186 AcpiNsGetNextNode ( 187 ACPI_OBJECT_TYPE Type, 188 ACPI_NAMESPACE_NODE *Parent, 189 ACPI_NAMESPACE_NODE *Child); 190 191 192 /* 193 * nsparse - table parsing 194 */ 195 ACPI_STATUS 196 AcpiNsParseTable ( 197 ACPI_TABLE_DESC *TableDesc, 198 ACPI_NAMESPACE_NODE *Scope); 199 200 ACPI_STATUS 201 AcpiNsOneCompleteParse ( 202 UINT8 PassNumber, 203 ACPI_TABLE_DESC *TableDesc); 204 205 206 /* 207 * nsaccess - Top-level namespace access 208 */ 209 ACPI_STATUS 210 AcpiNsRootInitialize ( 211 void); 212 213 ACPI_STATUS 214 AcpiNsLookup ( 215 ACPI_GENERIC_STATE *ScopeInfo, 216 char *Name, 217 ACPI_OBJECT_TYPE Type, 218 ACPI_INTERPRETER_MODE InterpreterMode, 219 UINT32 Flags, 220 ACPI_WALK_STATE *WalkState, 221 ACPI_NAMESPACE_NODE **RetNode); 222 223 224 /* 225 * nsalloc - Named object allocation/deallocation 226 */ 227 ACPI_NAMESPACE_NODE * 228 AcpiNsCreateNode ( 229 UINT32 Name); 230 231 void 232 AcpiNsDeleteNode ( 233 ACPI_NAMESPACE_NODE *Node); 234 235 void 236 AcpiNsDeleteNamespaceSubtree ( 237 ACPI_NAMESPACE_NODE *ParentHandle); 238 239 void 240 AcpiNsDeleteNamespaceByOwner ( 241 ACPI_OWNER_ID OwnerId); 242 243 void 244 AcpiNsDetachObject ( 245 ACPI_NAMESPACE_NODE *Node); 246 247 void 248 AcpiNsDeleteChildren ( 249 ACPI_NAMESPACE_NODE *Parent); 250 251 int 252 AcpiNsCompareNames ( 253 char *Name1, 254 char *Name2); 255 256 257 /* 258 * nsdump - Namespace dump/print utilities 259 */ 260 void 261 AcpiNsDumpTables ( 262 ACPI_HANDLE SearchBase, 263 UINT32 MaxDepth); 264 265 void 266 AcpiNsDumpEntry ( 267 ACPI_HANDLE Handle, 268 UINT32 DebugLevel); 269 270 void 271 AcpiNsDumpPathname ( 272 ACPI_HANDLE Handle, 273 char *Msg, 274 UINT32 Level, 275 UINT32 Component); 276 277 void 278 AcpiNsPrintPathname ( 279 UINT32 NumSegments, 280 char *Pathname); 281 282 ACPI_STATUS 283 AcpiNsDumpOneObject ( 284 ACPI_HANDLE ObjHandle, 285 UINT32 Level, 286 void *Context, 287 void **ReturnValue); 288 289 void 290 AcpiNsDumpObjects ( 291 ACPI_OBJECT_TYPE Type, 292 UINT8 DisplayType, 293 UINT32 MaxDepth, 294 ACPI_OWNER_ID OwnerId, 295 ACPI_HANDLE StartHandle); 296 297 298 /* 299 * nseval - Namespace evaluation functions 300 */ 301 ACPI_STATUS 302 AcpiNsEvaluate ( 303 ACPI_EVALUATE_INFO *Info); 304 305 306 /* 307 * nsnames - Name and Scope manipulation 308 */ 309 UINT32 310 AcpiNsOpensScope ( 311 ACPI_OBJECT_TYPE Type); 312 313 void 314 AcpiNsBuildExternalPath ( 315 ACPI_NAMESPACE_NODE *Node, 316 ACPI_SIZE Size, 317 char *NameBuffer); 318 319 char * 320 AcpiNsGetExternalPathname ( 321 ACPI_NAMESPACE_NODE *Node); 322 323 char * 324 AcpiNsNameOfCurrentScope ( 325 ACPI_WALK_STATE *WalkState); 326 327 ACPI_STATUS 328 AcpiNsHandleToPathname ( 329 ACPI_HANDLE TargetHandle, 330 ACPI_BUFFER *Buffer); 331 332 BOOLEAN 333 AcpiNsPatternMatch ( 334 ACPI_NAMESPACE_NODE *ObjNode, 335 char *SearchFor); 336 337 ACPI_STATUS 338 AcpiNsGetNode ( 339 ACPI_NAMESPACE_NODE *PrefixNode, 340 char *ExternalPathname, 341 UINT32 Flags, 342 ACPI_NAMESPACE_NODE **OutNode); 343 344 ACPI_SIZE 345 AcpiNsGetPathnameLength ( 346 ACPI_NAMESPACE_NODE *Node); 347 348 349 /* 350 * nsobject - Object management for namespace nodes 351 */ 352 ACPI_STATUS 353 AcpiNsAttachObject ( 354 ACPI_NAMESPACE_NODE *Node, 355 ACPI_OPERAND_OBJECT *Object, 356 ACPI_OBJECT_TYPE Type); 357 358 ACPI_OPERAND_OBJECT * 359 AcpiNsGetAttachedObject ( 360 ACPI_NAMESPACE_NODE *Node); 361 362 ACPI_OPERAND_OBJECT * 363 AcpiNsGetSecondaryObject ( 364 ACPI_OPERAND_OBJECT *ObjDesc); 365 366 ACPI_STATUS 367 AcpiNsAttachData ( 368 ACPI_NAMESPACE_NODE *Node, 369 ACPI_OBJECT_HANDLER Handler, 370 void *Data); 371 372 ACPI_STATUS 373 AcpiNsDetachData ( 374 ACPI_NAMESPACE_NODE *Node, 375 ACPI_OBJECT_HANDLER Handler); 376 377 ACPI_STATUS 378 AcpiNsGetAttachedData ( 379 ACPI_NAMESPACE_NODE *Node, 380 ACPI_OBJECT_HANDLER Handler, 381 void **Data); 382 383 384 /* 385 * nssearch - Namespace searching and entry 386 */ 387 ACPI_STATUS 388 AcpiNsSearchAndEnter ( 389 UINT32 EntryName, 390 ACPI_WALK_STATE *WalkState, 391 ACPI_NAMESPACE_NODE *Node, 392 ACPI_INTERPRETER_MODE InterpreterMode, 393 ACPI_OBJECT_TYPE Type, 394 UINT32 Flags, 395 ACPI_NAMESPACE_NODE **RetNode); 396 397 ACPI_STATUS 398 AcpiNsSearchOneScope ( 399 UINT32 EntryName, 400 ACPI_NAMESPACE_NODE *Node, 401 ACPI_OBJECT_TYPE Type, 402 ACPI_NAMESPACE_NODE **RetNode); 403 404 void 405 AcpiNsInstallNode ( 406 ACPI_WALK_STATE *WalkState, 407 ACPI_NAMESPACE_NODE *ParentNode, 408 ACPI_NAMESPACE_NODE *Node, 409 ACPI_OBJECT_TYPE Type); 410 411 412 /* 413 * nsutils - Utility functions 414 */ 415 BOOLEAN 416 AcpiNsValidRootPrefix ( 417 char Prefix); 418 419 ACPI_OBJECT_TYPE 420 AcpiNsGetType ( 421 ACPI_NAMESPACE_NODE *Node); 422 423 UINT32 424 AcpiNsLocal ( 425 ACPI_OBJECT_TYPE Type); 426 427 void 428 AcpiNsReportError ( 429 char *ModuleName, 430 UINT32 LineNumber, 431 char *InternalName, 432 ACPI_STATUS LookupStatus); 433 434 void 435 AcpiNsReportMethodError ( 436 char *ModuleName, 437 UINT32 LineNumber, 438 char *Message, 439 ACPI_NAMESPACE_NODE *Node, 440 char *Path, 441 ACPI_STATUS LookupStatus); 442 443 void 444 AcpiNsPrintNodePathname ( 445 ACPI_NAMESPACE_NODE *Node, 446 char *Msg); 447 448 ACPI_STATUS 449 AcpiNsBuildInternalName ( 450 ACPI_NAMESTRING_INFO *Info); 451 452 void 453 AcpiNsGetInternalNameLength ( 454 ACPI_NAMESTRING_INFO *Info); 455 456 ACPI_STATUS 457 AcpiNsInternalizeName ( 458 char *DottedName, 459 char **ConvertedName); 460 461 ACPI_STATUS 462 AcpiNsExternalizeName ( 463 UINT32 InternalNameLength, 464 char *InternalName, 465 UINT32 *ConvertedNameLength, 466 char **ConvertedName); 467 468 ACPI_NAMESPACE_NODE * 469 AcpiNsMapHandleToNode ( 470 ACPI_HANDLE Handle); 471 472 ACPI_HANDLE 473 AcpiNsConvertEntryToHandle( 474 ACPI_NAMESPACE_NODE *Node); 475 476 void 477 AcpiNsTerminate ( 478 void); 479 480 ACPI_NAMESPACE_NODE * 481 AcpiNsGetParentNode ( 482 ACPI_NAMESPACE_NODE *Node); 483 484 485 ACPI_NAMESPACE_NODE * 486 AcpiNsGetNextValidNode ( 487 ACPI_NAMESPACE_NODE *Node); 488 489 #endif /* __ACNAMESP_H__ */ 490