1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #ifndef __ACNAMESP_H__ 117 #define __ACNAMESP_H__ 118 119 120 /* To search the entire name space, pass this as SearchBase */ 121 122 #define ACPI_NS_ALL ((ACPI_HANDLE)0) 123 124 /* 125 * Elements of AcpiNsProperties are bit significant 126 * and should be one-to-one with values of ACPI_OBJECT_TYPE 127 */ 128 #define ACPI_NS_NORMAL 0 129 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */ 130 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */ 131 132 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */ 133 134 #define ACPI_NS_NO_UPSEARCH 0 135 #define ACPI_NS_SEARCH_PARENT 0x01 136 #define ACPI_NS_DONT_OPEN_SCOPE 0x02 137 #define ACPI_NS_NO_PEER_SEARCH 0x04 138 #define ACPI_NS_ERROR_IF_FOUND 0x08 139 #define ACPI_NS_PREFIX_IS_SCOPE 0x10 140 #define ACPI_NS_EXTERNAL 0x20 141 #define ACPI_NS_TEMPORARY 0x40 142 143 /* Flags for AcpiNsWalkNamespace */ 144 145 #define ACPI_NS_WALK_NO_UNLOCK 0 146 #define ACPI_NS_WALK_UNLOCK 0x01 147 #define ACPI_NS_WALK_TEMP_NODES 0x02 148 149 /* Object is not a package element */ 150 151 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX 152 153 /* Always emit warning message, not dependent on node flags */ 154 155 #define ACPI_WARN_ALWAYS 0 156 157 158 /* 159 * nsinit - Namespace initialization 160 */ 161 ACPI_STATUS 162 AcpiNsInitializeObjects ( 163 void); 164 165 ACPI_STATUS 166 AcpiNsInitializeDevices ( 167 void); 168 169 170 /* 171 * nsload - Namespace loading 172 */ 173 ACPI_STATUS 174 AcpiNsLoadNamespace ( 175 void); 176 177 ACPI_STATUS 178 AcpiNsLoadTable ( 179 UINT32 TableIndex, 180 ACPI_NAMESPACE_NODE *Node); 181 182 183 /* 184 * nswalk - walk the namespace 185 */ 186 ACPI_STATUS 187 AcpiNsWalkNamespace ( 188 ACPI_OBJECT_TYPE Type, 189 ACPI_HANDLE StartObject, 190 UINT32 MaxDepth, 191 UINT32 Flags, 192 ACPI_WALK_CALLBACK DescendingCallback, 193 ACPI_WALK_CALLBACK AscendingCallback, 194 void *Context, 195 void **ReturnValue); 196 197 ACPI_NAMESPACE_NODE * 198 AcpiNsGetNextNode ( 199 ACPI_NAMESPACE_NODE *Parent, 200 ACPI_NAMESPACE_NODE *Child); 201 202 ACPI_NAMESPACE_NODE * 203 AcpiNsGetNextNodeTyped ( 204 ACPI_OBJECT_TYPE Type, 205 ACPI_NAMESPACE_NODE *Parent, 206 ACPI_NAMESPACE_NODE *Child); 207 208 /* 209 * nsparse - table parsing 210 */ 211 ACPI_STATUS 212 AcpiNsParseTable ( 213 UINT32 TableIndex, 214 ACPI_NAMESPACE_NODE *StartNode); 215 216 ACPI_STATUS 217 AcpiNsOneCompleteParse ( 218 UINT32 PassNumber, 219 UINT32 TableIndex, 220 ACPI_NAMESPACE_NODE *StartNode); 221 222 223 /* 224 * nsaccess - Top-level namespace access 225 */ 226 ACPI_STATUS 227 AcpiNsRootInitialize ( 228 void); 229 230 ACPI_STATUS 231 AcpiNsLookup ( 232 ACPI_GENERIC_STATE *ScopeInfo, 233 char *Name, 234 ACPI_OBJECT_TYPE Type, 235 ACPI_INTERPRETER_MODE InterpreterMode, 236 UINT32 Flags, 237 ACPI_WALK_STATE *WalkState, 238 ACPI_NAMESPACE_NODE **RetNode); 239 240 241 /* 242 * nsalloc - Named object allocation/deallocation 243 */ 244 ACPI_NAMESPACE_NODE * 245 AcpiNsCreateNode ( 246 UINT32 Name); 247 248 void 249 AcpiNsDeleteNode ( 250 ACPI_NAMESPACE_NODE *Node); 251 252 void 253 AcpiNsRemoveNode ( 254 ACPI_NAMESPACE_NODE *Node); 255 256 void 257 AcpiNsDeleteNamespaceSubtree ( 258 ACPI_NAMESPACE_NODE *ParentHandle); 259 260 void 261 AcpiNsDeleteNamespaceByOwner ( 262 ACPI_OWNER_ID OwnerId); 263 264 void 265 AcpiNsDetachObject ( 266 ACPI_NAMESPACE_NODE *Node); 267 268 void 269 AcpiNsDeleteChildren ( 270 ACPI_NAMESPACE_NODE *Parent); 271 272 int 273 AcpiNsCompareNames ( 274 char *Name1, 275 char *Name2); 276 277 278 /* 279 * nsconvert - Dynamic object conversion routines 280 */ 281 ACPI_STATUS 282 AcpiNsConvertToInteger ( 283 ACPI_OPERAND_OBJECT *OriginalObject, 284 ACPI_OPERAND_OBJECT **ReturnObject); 285 286 ACPI_STATUS 287 AcpiNsConvertToString ( 288 ACPI_OPERAND_OBJECT *OriginalObject, 289 ACPI_OPERAND_OBJECT **ReturnObject); 290 291 ACPI_STATUS 292 AcpiNsConvertToBuffer ( 293 ACPI_OPERAND_OBJECT *OriginalObject, 294 ACPI_OPERAND_OBJECT **ReturnObject); 295 296 ACPI_STATUS 297 AcpiNsConvertToUnicode ( 298 ACPI_OPERAND_OBJECT *OriginalObject, 299 ACPI_OPERAND_OBJECT **ReturnObject); 300 301 ACPI_STATUS 302 AcpiNsConvertToResource ( 303 ACPI_OPERAND_OBJECT *OriginalObject, 304 ACPI_OPERAND_OBJECT **ReturnObject); 305 306 307 /* 308 * nsdump - Namespace dump/print utilities 309 */ 310 void 311 AcpiNsDumpTables ( 312 ACPI_HANDLE SearchBase, 313 UINT32 MaxDepth); 314 315 void 316 AcpiNsDumpEntry ( 317 ACPI_HANDLE Handle, 318 UINT32 DebugLevel); 319 320 void 321 AcpiNsDumpPathname ( 322 ACPI_HANDLE Handle, 323 char *Msg, 324 UINT32 Level, 325 UINT32 Component); 326 327 void 328 AcpiNsPrintPathname ( 329 UINT32 NumSegments, 330 char *Pathname); 331 332 ACPI_STATUS 333 AcpiNsDumpOneObject ( 334 ACPI_HANDLE ObjHandle, 335 UINT32 Level, 336 void *Context, 337 void **ReturnValue); 338 339 void 340 AcpiNsDumpObjects ( 341 ACPI_OBJECT_TYPE Type, 342 UINT8 DisplayType, 343 UINT32 MaxDepth, 344 ACPI_OWNER_ID OwnerId, 345 ACPI_HANDLE StartHandle); 346 347 void 348 AcpiNsDumpObjectPaths ( 349 ACPI_OBJECT_TYPE Type, 350 UINT8 DisplayType, 351 UINT32 MaxDepth, 352 ACPI_OWNER_ID OwnerId, 353 ACPI_HANDLE StartHandle); 354 355 356 /* 357 * nseval - Namespace evaluation functions 358 */ 359 ACPI_STATUS 360 AcpiNsEvaluate ( 361 ACPI_EVALUATE_INFO *Info); 362 363 void 364 AcpiNsExecModuleCodeList ( 365 void); 366 367 368 /* 369 * nsarguments - Argument count/type checking for predefined/reserved names 370 */ 371 void 372 AcpiNsCheckArgumentCount ( 373 char *Pathname, 374 ACPI_NAMESPACE_NODE *Node, 375 UINT32 UserParamCount, 376 const ACPI_PREDEFINED_INFO *Info); 377 378 void 379 AcpiNsCheckAcpiCompliance ( 380 char *Pathname, 381 ACPI_NAMESPACE_NODE *Node, 382 const ACPI_PREDEFINED_INFO *Predefined); 383 384 void 385 AcpiNsCheckArgumentTypes ( 386 ACPI_EVALUATE_INFO *Info); 387 388 389 /* 390 * nspredef - Return value checking for predefined/reserved names 391 */ 392 ACPI_STATUS 393 AcpiNsCheckReturnValue ( 394 ACPI_NAMESPACE_NODE *Node, 395 ACPI_EVALUATE_INFO *Info, 396 UINT32 UserParamCount, 397 ACPI_STATUS ReturnStatus, 398 ACPI_OPERAND_OBJECT **ReturnObject); 399 400 ACPI_STATUS 401 AcpiNsCheckObjectType ( 402 ACPI_EVALUATE_INFO *Info, 403 ACPI_OPERAND_OBJECT **ReturnObjectPtr, 404 UINT32 ExpectedBtypes, 405 UINT32 PackageIndex); 406 407 408 /* 409 * nsprepkg - Validation of predefined name packages 410 */ 411 ACPI_STATUS 412 AcpiNsCheckPackage ( 413 ACPI_EVALUATE_INFO *Info, 414 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 415 416 417 /* 418 * nsnames - Name and Scope manipulation 419 */ 420 UINT32 421 AcpiNsOpensScope ( 422 ACPI_OBJECT_TYPE Type); 423 424 ACPI_STATUS 425 AcpiNsBuildExternalPath ( 426 ACPI_NAMESPACE_NODE *Node, 427 ACPI_SIZE Size, 428 char *NameBuffer); 429 430 char * 431 AcpiNsGetExternalPathname ( 432 ACPI_NAMESPACE_NODE *Node); 433 434 char * 435 AcpiNsNameOfCurrentScope ( 436 ACPI_WALK_STATE *WalkState); 437 438 ACPI_STATUS 439 AcpiNsHandleToPathname ( 440 ACPI_HANDLE TargetHandle, 441 ACPI_BUFFER *Buffer); 442 443 BOOLEAN 444 AcpiNsPatternMatch ( 445 ACPI_NAMESPACE_NODE *ObjNode, 446 char *SearchFor); 447 448 ACPI_STATUS 449 AcpiNsGetNode ( 450 ACPI_NAMESPACE_NODE *PrefixNode, 451 const char *ExternalPathname, 452 UINT32 Flags, 453 ACPI_NAMESPACE_NODE **OutNode); 454 455 ACPI_SIZE 456 AcpiNsGetPathnameLength ( 457 ACPI_NAMESPACE_NODE *Node); 458 459 460 /* 461 * nsobject - Object management for namespace nodes 462 */ 463 ACPI_STATUS 464 AcpiNsAttachObject ( 465 ACPI_NAMESPACE_NODE *Node, 466 ACPI_OPERAND_OBJECT *Object, 467 ACPI_OBJECT_TYPE Type); 468 469 ACPI_OPERAND_OBJECT * 470 AcpiNsGetAttachedObject ( 471 ACPI_NAMESPACE_NODE *Node); 472 473 ACPI_OPERAND_OBJECT * 474 AcpiNsGetSecondaryObject ( 475 ACPI_OPERAND_OBJECT *ObjDesc); 476 477 ACPI_STATUS 478 AcpiNsAttachData ( 479 ACPI_NAMESPACE_NODE *Node, 480 ACPI_OBJECT_HANDLER Handler, 481 void *Data); 482 483 ACPI_STATUS 484 AcpiNsDetachData ( 485 ACPI_NAMESPACE_NODE *Node, 486 ACPI_OBJECT_HANDLER Handler); 487 488 ACPI_STATUS 489 AcpiNsGetAttachedData ( 490 ACPI_NAMESPACE_NODE *Node, 491 ACPI_OBJECT_HANDLER Handler, 492 void **Data); 493 494 495 /* 496 * nsrepair - General return object repair for all 497 * predefined methods/objects 498 */ 499 ACPI_STATUS 500 AcpiNsSimpleRepair ( 501 ACPI_EVALUATE_INFO *Info, 502 UINT32 ExpectedBtypes, 503 UINT32 PackageIndex, 504 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 505 506 ACPI_STATUS 507 AcpiNsWrapWithPackage ( 508 ACPI_EVALUATE_INFO *Info, 509 ACPI_OPERAND_OBJECT *OriginalObject, 510 ACPI_OPERAND_OBJECT **ObjDescPtr); 511 512 ACPI_STATUS 513 AcpiNsRepairNullElement ( 514 ACPI_EVALUATE_INFO *Info, 515 UINT32 ExpectedBtypes, 516 UINT32 PackageIndex, 517 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 518 519 void 520 AcpiNsRemoveNullElements ( 521 ACPI_EVALUATE_INFO *Info, 522 UINT8 PackageType, 523 ACPI_OPERAND_OBJECT *ObjDesc); 524 525 526 /* 527 * nsrepair2 - Return object repair for specific 528 * predefined methods/objects 529 */ 530 ACPI_STATUS 531 AcpiNsComplexRepairs ( 532 ACPI_EVALUATE_INFO *Info, 533 ACPI_NAMESPACE_NODE *Node, 534 ACPI_STATUS ValidateStatus, 535 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 536 537 538 /* 539 * nssearch - Namespace searching and entry 540 */ 541 ACPI_STATUS 542 AcpiNsSearchAndEnter ( 543 UINT32 EntryName, 544 ACPI_WALK_STATE *WalkState, 545 ACPI_NAMESPACE_NODE *Node, 546 ACPI_INTERPRETER_MODE InterpreterMode, 547 ACPI_OBJECT_TYPE Type, 548 UINT32 Flags, 549 ACPI_NAMESPACE_NODE **RetNode); 550 551 ACPI_STATUS 552 AcpiNsSearchOneScope ( 553 UINT32 EntryName, 554 ACPI_NAMESPACE_NODE *Node, 555 ACPI_OBJECT_TYPE Type, 556 ACPI_NAMESPACE_NODE **RetNode); 557 558 void 559 AcpiNsInstallNode ( 560 ACPI_WALK_STATE *WalkState, 561 ACPI_NAMESPACE_NODE *ParentNode, 562 ACPI_NAMESPACE_NODE *Node, 563 ACPI_OBJECT_TYPE Type); 564 565 566 /* 567 * nsutils - Utility functions 568 */ 569 ACPI_OBJECT_TYPE 570 AcpiNsGetType ( 571 ACPI_NAMESPACE_NODE *Node); 572 573 UINT32 574 AcpiNsLocal ( 575 ACPI_OBJECT_TYPE Type); 576 577 void 578 AcpiNsPrintNodePathname ( 579 ACPI_NAMESPACE_NODE *Node, 580 const char *Msg); 581 582 ACPI_STATUS 583 AcpiNsBuildInternalName ( 584 ACPI_NAMESTRING_INFO *Info); 585 586 void 587 AcpiNsGetInternalNameLength ( 588 ACPI_NAMESTRING_INFO *Info); 589 590 ACPI_STATUS 591 AcpiNsInternalizeName ( 592 const char *DottedName, 593 char **ConvertedName); 594 595 ACPI_STATUS 596 AcpiNsExternalizeName ( 597 UINT32 InternalNameLength, 598 const char *InternalName, 599 UINT32 *ConvertedNameLength, 600 char **ConvertedName); 601 602 ACPI_NAMESPACE_NODE * 603 AcpiNsValidateHandle ( 604 ACPI_HANDLE Handle); 605 606 void 607 AcpiNsTerminate ( 608 void); 609 610 #endif /* __ACNAMESP_H__ */ 611