acnamesp.h revision 129684
1/****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * $Revision: 136 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 134/* Definitions of the predefined namespace names */ 135 136#define ACPI_UNKNOWN_NAME (UINT32) 0x3F3F3F3F /* Unknown name is "????" */ 137#define ACPI_ROOT_NAME (UINT32) 0x5F5F5F5C /* Root name is "\___" */ 138#define ACPI_SYS_BUS_NAME (UINT32) 0x5F53425F /* Sys bus name is "_SB_" */ 139 140#define ACPI_NS_ROOT_PATH "\\" 141#define ACPI_NS_SYSTEM_BUS "_SB_" 142 143 144/* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */ 145 146#define ACPI_NS_NO_UPSEARCH 0 147#define ACPI_NS_SEARCH_PARENT 0x01 148#define ACPI_NS_DONT_OPEN_SCOPE 0x02 149#define ACPI_NS_NO_PEER_SEARCH 0x04 150#define ACPI_NS_ERROR_IF_FOUND 0x08 151 152#define ACPI_NS_WALK_UNLOCK TRUE 153#define ACPI_NS_WALK_NO_UNLOCK FALSE 154 155 156ACPI_STATUS 157AcpiNsLoadNamespace ( 158 void); 159 160ACPI_STATUS 161AcpiNsInitializeObjects ( 162 void); 163 164ACPI_STATUS 165AcpiNsInitializeDevices ( 166 void); 167 168 169/* Namespace init - nsxfinit */ 170 171ACPI_STATUS 172AcpiNsInitOneDevice ( 173 ACPI_HANDLE ObjHandle, 174 UINT32 NestingLevel, 175 void *Context, 176 void **ReturnValue); 177 178ACPI_STATUS 179AcpiNsInitOneObject ( 180 ACPI_HANDLE ObjHandle, 181 UINT32 Level, 182 void *Context, 183 void **ReturnValue); 184 185 186ACPI_STATUS 187AcpiNsWalkNamespace ( 188 ACPI_OBJECT_TYPE Type, 189 ACPI_HANDLE StartObject, 190 UINT32 MaxDepth, 191 BOOLEAN UnlockBeforeCallback, 192 ACPI_WALK_CALLBACK UserFunction, 193 void *Context, 194 void **ReturnValue); 195 196ACPI_NAMESPACE_NODE * 197AcpiNsGetNextNode ( 198 ACPI_OBJECT_TYPE Type, 199 ACPI_NAMESPACE_NODE *Parent, 200 ACPI_NAMESPACE_NODE *Child); 201 202void 203AcpiNsDeleteNamespaceByOwner ( 204 UINT16 TableId); 205 206 207/* Namespace loading - nsload */ 208 209ACPI_STATUS 210AcpiNsOneCompleteParse ( 211 UINT32 PassNumber, 212 ACPI_TABLE_DESC *TableDesc); 213 214ACPI_STATUS 215AcpiNsParseTable ( 216 ACPI_TABLE_DESC *TableDesc, 217 ACPI_NAMESPACE_NODE *Scope); 218 219ACPI_STATUS 220AcpiNsLoadTable ( 221 ACPI_TABLE_DESC *TableDesc, 222 ACPI_NAMESPACE_NODE *Node); 223 224ACPI_STATUS 225AcpiNsLoadTableByType ( 226 ACPI_TABLE_TYPE TableType); 227 228 229/* 230 * Top-level namespace access - nsaccess 231 */ 232 233ACPI_STATUS 234AcpiNsRootInitialize ( 235 void); 236 237ACPI_STATUS 238AcpiNsLookup ( 239 ACPI_GENERIC_STATE *ScopeInfo, 240 char *Name, 241 ACPI_OBJECT_TYPE Type, 242 ACPI_INTERPRETER_MODE InterpreterMode, 243 UINT32 Flags, 244 ACPI_WALK_STATE *WalkState, 245 ACPI_NAMESPACE_NODE **RetNode); 246 247 248/* 249 * Named object allocation/deallocation - nsalloc 250 */ 251 252ACPI_NAMESPACE_NODE * 253AcpiNsCreateNode ( 254 UINT32 Name); 255 256void 257AcpiNsDeleteNode ( 258 ACPI_NAMESPACE_NODE *Node); 259 260void 261AcpiNsDeleteNamespaceSubtree ( 262 ACPI_NAMESPACE_NODE *ParentHandle); 263 264void 265AcpiNsDetachObject ( 266 ACPI_NAMESPACE_NODE *Node); 267 268void 269AcpiNsDeleteChildren ( 270 ACPI_NAMESPACE_NODE *Parent); 271 272int 273AcpiNsCompareNames ( 274 char *Name1, 275 char *Name2); 276 277void 278AcpiNsRemoveReference ( 279 ACPI_NAMESPACE_NODE *Node); 280 281 282/* 283 * Namespace modification - nsmodify 284 */ 285 286ACPI_STATUS 287AcpiNsUnloadNamespace ( 288 ACPI_HANDLE Handle); 289 290ACPI_STATUS 291AcpiNsDeleteSubtree ( 292 ACPI_HANDLE StartHandle); 293 294 295/* 296 * Namespace dump/print utilities - nsdump 297 */ 298 299void 300AcpiNsDumpTables ( 301 ACPI_HANDLE SearchBase, 302 UINT32 MaxDepth); 303 304void 305AcpiNsDumpEntry ( 306 ACPI_HANDLE Handle, 307 UINT32 DebugLevel); 308 309void 310AcpiNsDumpPathname ( 311 ACPI_HANDLE Handle, 312 char *Msg, 313 UINT32 Level, 314 UINT32 Component); 315 316void 317AcpiNsPrintPathname ( 318 UINT32 NumSegments, 319 char *Pathname); 320 321ACPI_STATUS 322AcpiNsDumpOneDevice ( 323 ACPI_HANDLE ObjHandle, 324 UINT32 Level, 325 void *Context, 326 void **ReturnValue); 327 328void 329AcpiNsDumpRootDevices ( 330 void); 331 332ACPI_STATUS 333AcpiNsDumpOneObject ( 334 ACPI_HANDLE ObjHandle, 335 UINT32 Level, 336 void *Context, 337 void **ReturnValue); 338 339void 340AcpiNsDumpObjects ( 341 ACPI_OBJECT_TYPE Type, 342 UINT8 DisplayType, 343 UINT32 MaxDepth, 344 UINT32 OwnderId, 345 ACPI_HANDLE StartHandle); 346 347 348/* 349 * Namespace evaluation functions - nseval 350 */ 351 352ACPI_STATUS 353AcpiNsEvaluateByHandle ( 354 ACPI_PARAMETER_INFO *Info); 355 356ACPI_STATUS 357AcpiNsEvaluateByName ( 358 char *Pathname, 359 ACPI_PARAMETER_INFO *Info); 360 361ACPI_STATUS 362AcpiNsEvaluateRelative ( 363 char *Pathname, 364 ACPI_PARAMETER_INFO *Info); 365 366ACPI_STATUS 367AcpiNsExecuteControlMethod ( 368 ACPI_PARAMETER_INFO *Info); 369 370ACPI_STATUS 371AcpiNsGetObjectValue ( 372 ACPI_PARAMETER_INFO *Info); 373 374 375/* 376 * Parent/Child/Peer utility functions 377 */ 378 379ACPI_NAME 380AcpiNsFindParentName ( 381 ACPI_NAMESPACE_NODE *NodeToSearch); 382 383 384/* 385 * Name and Scope manipulation - nsnames 386 */ 387 388UINT32 389AcpiNsOpensScope ( 390 ACPI_OBJECT_TYPE Type); 391 392void 393AcpiNsBuildExternalPath ( 394 ACPI_NAMESPACE_NODE *Node, 395 ACPI_SIZE Size, 396 char *NameBuffer); 397 398char * 399AcpiNsGetExternalPathname ( 400 ACPI_NAMESPACE_NODE *Node); 401 402char * 403AcpiNsNameOfCurrentScope ( 404 ACPI_WALK_STATE *WalkState); 405 406ACPI_STATUS 407AcpiNsHandleToPathname ( 408 ACPI_HANDLE TargetHandle, 409 ACPI_BUFFER *Buffer); 410 411BOOLEAN 412AcpiNsPatternMatch ( 413 ACPI_NAMESPACE_NODE *ObjNode, 414 char *SearchFor); 415 416ACPI_STATUS 417AcpiNsGetNodeByPath ( 418 char *ExternalPathname, 419 ACPI_NAMESPACE_NODE *InPrefixNode, 420 UINT32 Flags, 421 ACPI_NAMESPACE_NODE **OutNode); 422 423ACPI_SIZE 424AcpiNsGetPathnameLength ( 425 ACPI_NAMESPACE_NODE *Node); 426 427 428/* 429 * Object management for namespace nodes - nsobject 430 */ 431 432ACPI_STATUS 433AcpiNsAttachObject ( 434 ACPI_NAMESPACE_NODE *Node, 435 ACPI_OPERAND_OBJECT *Object, 436 ACPI_OBJECT_TYPE Type); 437 438ACPI_OPERAND_OBJECT * 439AcpiNsGetAttachedObject ( 440 ACPI_NAMESPACE_NODE *Node); 441 442ACPI_OPERAND_OBJECT * 443AcpiNsGetSecondaryObject ( 444 ACPI_OPERAND_OBJECT *ObjDesc); 445 446ACPI_STATUS 447AcpiNsAttachData ( 448 ACPI_NAMESPACE_NODE *Node, 449 ACPI_OBJECT_HANDLER Handler, 450 void *Data); 451 452ACPI_STATUS 453AcpiNsDetachData ( 454 ACPI_NAMESPACE_NODE *Node, 455 ACPI_OBJECT_HANDLER Handler); 456 457ACPI_STATUS 458AcpiNsGetAttachedData ( 459 ACPI_NAMESPACE_NODE *Node, 460 ACPI_OBJECT_HANDLER Handler, 461 void **Data); 462 463 464/* 465 * Namespace searching and entry - nssearch 466 */ 467 468ACPI_STATUS 469AcpiNsSearchAndEnter ( 470 UINT32 EntryName, 471 ACPI_WALK_STATE *WalkState, 472 ACPI_NAMESPACE_NODE *Node, 473 ACPI_INTERPRETER_MODE InterpreterMode, 474 ACPI_OBJECT_TYPE Type, 475 UINT32 Flags, 476 ACPI_NAMESPACE_NODE **RetNode); 477 478ACPI_STATUS 479AcpiNsSearchNode ( 480 UINT32 EntryName, 481 ACPI_NAMESPACE_NODE *Node, 482 ACPI_OBJECT_TYPE Type, 483 ACPI_NAMESPACE_NODE **RetNode); 484 485void 486AcpiNsInstallNode ( 487 ACPI_WALK_STATE *WalkState, 488 ACPI_NAMESPACE_NODE *ParentNode, 489 ACPI_NAMESPACE_NODE *Node, 490 ACPI_OBJECT_TYPE Type); 491 492 493/* 494 * Utility functions - nsutils 495 */ 496 497BOOLEAN 498AcpiNsValidRootPrefix ( 499 char Prefix); 500 501BOOLEAN 502AcpiNsValidPathSeparator ( 503 char Sep); 504 505ACPI_OBJECT_TYPE 506AcpiNsGetType ( 507 ACPI_NAMESPACE_NODE *Node); 508 509UINT32 510AcpiNsLocal ( 511 ACPI_OBJECT_TYPE Type); 512 513void 514AcpiNsReportError ( 515 char *ModuleName, 516 UINT32 LineNumber, 517 UINT32 ComponentId, 518 char *InternalName, 519 ACPI_STATUS LookupStatus); 520 521void 522AcpiNsReportMethodError ( 523 char *ModuleName, 524 UINT32 LineNumber, 525 UINT32 ComponentId, 526 char *Message, 527 ACPI_NAMESPACE_NODE *Node, 528 char *Path, 529 ACPI_STATUS LookupStatus); 530 531void 532AcpiNsPrintNodePathname ( 533 ACPI_NAMESPACE_NODE *Node, 534 char *Msg); 535 536ACPI_STATUS 537AcpiNsBuildInternalName ( 538 ACPI_NAMESTRING_INFO *Info); 539 540void 541AcpiNsGetInternalNameLength ( 542 ACPI_NAMESTRING_INFO *Info); 543 544ACPI_STATUS 545AcpiNsInternalizeName ( 546 char *DottedName, 547 char **ConvertedName); 548 549ACPI_STATUS 550AcpiNsExternalizeName ( 551 UINT32 InternalNameLength, 552 char *InternalName, 553 UINT32 *ConvertedNameLength, 554 char **ConvertedName); 555 556ACPI_NAMESPACE_NODE * 557AcpiNsMapHandleToNode ( 558 ACPI_HANDLE Handle); 559 560ACPI_HANDLE 561AcpiNsConvertEntryToHandle( 562 ACPI_NAMESPACE_NODE *Node); 563 564void 565AcpiNsTerminate ( 566 void); 567 568ACPI_NAMESPACE_NODE * 569AcpiNsGetParentNode ( 570 ACPI_NAMESPACE_NODE *Node); 571 572 573ACPI_NAMESPACE_NODE * 574AcpiNsGetNextValidNode ( 575 ACPI_NAMESPACE_NODE *Node); 576 577 578#endif /* __ACNAMESP_H__ */ 579