acnamesp.h revision 91116
1/****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * $Revision: 123 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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) 0x2F202020 /* 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 202ACPI_STATUS 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 233 234ACPI_STATUS 235AcpiNsRootInitialize ( 236 void); 237 238ACPI_STATUS 239AcpiNsLookup ( 240 ACPI_GENERIC_STATE *ScopeInfo, 241 NATIVE_CHAR *Name, 242 ACPI_OBJECT_TYPE Type, 243 ACPI_INTERPRETER_MODE InterpreterMode, 244 UINT32 Flags, 245 ACPI_WALK_STATE *WalkState, 246 ACPI_NAMESPACE_NODE **RetNode); 247 248 249/* 250 * Named object allocation/deallocation - nsalloc 251 */ 252 253 254ACPI_NAMESPACE_NODE * 255AcpiNsCreateNode ( 256 UINT32 Name); 257 258void 259AcpiNsDeleteNode ( 260 ACPI_NAMESPACE_NODE *Node); 261 262ACPI_STATUS 263AcpiNsDeleteNamespaceSubtree ( 264 ACPI_NAMESPACE_NODE *ParentHandle); 265 266void 267AcpiNsDetachObject ( 268 ACPI_NAMESPACE_NODE *Node); 269 270void 271AcpiNsDeleteChildren ( 272 ACPI_NAMESPACE_NODE *Parent); 273 274 275/* 276 * Namespace modification - nsmodify 277 */ 278 279ACPI_STATUS 280AcpiNsUnloadNamespace ( 281 ACPI_HANDLE Handle); 282 283ACPI_STATUS 284AcpiNsDeleteSubtree ( 285 ACPI_HANDLE StartHandle); 286 287 288/* 289 * Namespace dump/print utilities - nsdump 290 */ 291 292void 293AcpiNsDumpTables ( 294 ACPI_HANDLE SearchBase, 295 UINT32 MaxDepth); 296 297void 298AcpiNsDumpEntry ( 299 ACPI_HANDLE Handle, 300 UINT32 DebugLevel); 301 302ACPI_STATUS 303AcpiNsDumpPathname ( 304 ACPI_HANDLE Handle, 305 NATIVE_CHAR *Msg, 306 UINT32 Level, 307 UINT32 Component); 308 309void 310AcpiNsPrintPathname ( 311 UINT32 NumSegments, 312 char *Pathname); 313 314void 315AcpiNsDumpRootDevices ( 316 void); 317 318void 319AcpiNsDumpObjects ( 320 ACPI_OBJECT_TYPE Type, 321 UINT8 DisplayType, 322 UINT32 MaxDepth, 323 UINT32 OwnderId, 324 ACPI_HANDLE StartHandle); 325 326 327/* 328 * Namespace evaluation functions - nseval 329 */ 330 331ACPI_STATUS 332AcpiNsEvaluateByHandle ( 333 ACPI_NAMESPACE_NODE *PrefixNode, 334 ACPI_OPERAND_OBJECT **Params, 335 ACPI_OPERAND_OBJECT **ReturnObject); 336 337ACPI_STATUS 338AcpiNsEvaluateByName ( 339 NATIVE_CHAR *Pathname, 340 ACPI_OPERAND_OBJECT **Params, 341 ACPI_OPERAND_OBJECT **ReturnObject); 342 343ACPI_STATUS 344AcpiNsEvaluateRelative ( 345 ACPI_NAMESPACE_NODE *PrefixNode, 346 NATIVE_CHAR *Pathname, 347 ACPI_OPERAND_OBJECT **Params, 348 ACPI_OPERAND_OBJECT **ReturnObject); 349 350ACPI_STATUS 351AcpiNsExecuteControlMethod ( 352 ACPI_NAMESPACE_NODE *MethodNode, 353 ACPI_OPERAND_OBJECT **Params, 354 ACPI_OPERAND_OBJECT **ReturnObjDesc); 355 356ACPI_STATUS 357AcpiNsGetObjectValue ( 358 ACPI_NAMESPACE_NODE *ObjectNode, 359 ACPI_OPERAND_OBJECT **ReturnObjDesc); 360 361 362/* 363 * Parent/Child/Peer utility functions - nsfamily 364 */ 365 366ACPI_NAME 367AcpiNsFindParentName ( 368 ACPI_NAMESPACE_NODE *NodeToSearch); 369 370BOOLEAN 371AcpiNsExistDownstreamSibling ( 372 ACPI_NAMESPACE_NODE *ThisNode); 373 374 375/* 376 * Name and Scope manipulation - nsnames 377 */ 378 379UINT32 380AcpiNsOpensScope ( 381 ACPI_OBJECT_TYPE Type); 382 383NATIVE_CHAR * 384AcpiNsGetExternalPathname ( 385 ACPI_NAMESPACE_NODE *Node); 386 387NATIVE_CHAR * 388AcpiNsNameOfCurrentScope ( 389 ACPI_WALK_STATE *WalkState); 390 391ACPI_STATUS 392AcpiNsHandleToPathname ( 393 ACPI_HANDLE TargetHandle, 394 ACPI_BUFFER *Buffer); 395 396BOOLEAN 397AcpiNsPatternMatch ( 398 ACPI_NAMESPACE_NODE *ObjNode, 399 NATIVE_CHAR *SearchFor); 400 401ACPI_STATUS 402AcpiNsGetNodeByPath ( 403 NATIVE_CHAR *ExternalPathname, 404 ACPI_NAMESPACE_NODE *InPrefixNode, 405 UINT32 Flags, 406 ACPI_NAMESPACE_NODE **OutNode); 407 408ACPI_SIZE 409AcpiNsGetPathnameLength ( 410 ACPI_NAMESPACE_NODE *Node); 411 412 413/* 414 * Object management for namespace nodes - nsobject 415 */ 416 417ACPI_STATUS 418AcpiNsAttachObject ( 419 ACPI_NAMESPACE_NODE *Node, 420 ACPI_OPERAND_OBJECT *Object, 421 ACPI_OBJECT_TYPE Type); 422 423ACPI_OPERAND_OBJECT * 424AcpiNsGetAttachedObject ( 425 ACPI_NAMESPACE_NODE *Node); 426 427ACPI_OPERAND_OBJECT * 428AcpiNsGetSecondaryObject ( 429 ACPI_OPERAND_OBJECT *ObjDesc); 430 431ACPI_STATUS 432AcpiNsAttachData ( 433 ACPI_NAMESPACE_NODE *Node, 434 ACPI_OBJECT_HANDLER Handler, 435 void *Data); 436 437ACPI_STATUS 438AcpiNsDetachData ( 439 ACPI_NAMESPACE_NODE *Node, 440 ACPI_OBJECT_HANDLER Handler); 441 442ACPI_STATUS 443AcpiNsGetAttachedData ( 444 ACPI_NAMESPACE_NODE *Node, 445 ACPI_OBJECT_HANDLER Handler, 446 void **Data); 447 448 449/* 450 * Namespace searching and entry - nssearch 451 */ 452 453ACPI_STATUS 454AcpiNsSearchAndEnter ( 455 UINT32 EntryName, 456 ACPI_WALK_STATE *WalkState, 457 ACPI_NAMESPACE_NODE *Node, 458 ACPI_INTERPRETER_MODE InterpreterMode, 459 ACPI_OBJECT_TYPE Type, 460 UINT32 Flags, 461 ACPI_NAMESPACE_NODE **RetNode); 462 463ACPI_STATUS 464AcpiNsSearchNode ( 465 UINT32 EntryName, 466 ACPI_NAMESPACE_NODE *Node, 467 ACPI_OBJECT_TYPE Type, 468 ACPI_NAMESPACE_NODE **RetNode); 469 470void 471AcpiNsInstallNode ( 472 ACPI_WALK_STATE *WalkState, 473 ACPI_NAMESPACE_NODE *ParentNode, /* Parent */ 474 ACPI_NAMESPACE_NODE *Node, /* New Child*/ 475 ACPI_OBJECT_TYPE Type); 476 477 478/* 479 * Utility functions - nsutils 480 */ 481 482BOOLEAN 483AcpiNsValidRootPrefix ( 484 NATIVE_CHAR Prefix); 485 486BOOLEAN 487AcpiNsValidPathSeparator ( 488 NATIVE_CHAR Sep); 489 490ACPI_OBJECT_TYPE 491AcpiNsGetType ( 492 ACPI_NAMESPACE_NODE *Node); 493 494UINT32 495AcpiNsLocal ( 496 ACPI_OBJECT_TYPE Type); 497 498ACPI_STATUS 499AcpiNsBuildInternalName ( 500 ACPI_NAMESTRING_INFO *Info); 501 502ACPI_STATUS 503AcpiNsGetInternalNameLength ( 504 ACPI_NAMESTRING_INFO *Info); 505 506ACPI_STATUS 507AcpiNsInternalizeName ( 508 NATIVE_CHAR *DottedName, 509 NATIVE_CHAR **ConvertedName); 510 511ACPI_STATUS 512AcpiNsExternalizeName ( 513 UINT32 InternalNameLength, 514 NATIVE_CHAR *InternalName, 515 UINT32 *ConvertedNameLength, 516 NATIVE_CHAR **ConvertedName); 517 518ACPI_NAMESPACE_NODE * 519AcpiNsMapHandleToNode ( 520 ACPI_HANDLE Handle); 521 522ACPI_HANDLE 523AcpiNsConvertEntryToHandle( 524 ACPI_NAMESPACE_NODE *Node); 525 526void 527AcpiNsTerminate ( 528 void); 529 530ACPI_NAMESPACE_NODE * 531AcpiNsGetParentNode ( 532 ACPI_NAMESPACE_NODE *Node); 533 534 535ACPI_NAMESPACE_NODE * 536AcpiNsGetNextValidNode ( 537 ACPI_NAMESPACE_NODE *Node); 538 539 540#endif /* __ACNAMESP_H__ */ 541