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