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 - 2016, 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 #define ACPI_NS_OVERRIDE_IF_FOUND 0x80 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 /* Object is not a package element */ 151 152 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX 153 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1) 154 155 /* Always emit warning message, not dependent on node flags */ 156 157 #define ACPI_WARN_ALWAYS 0 158 159 160 /* 161 * nsinit - Namespace initialization 162 */ 163 ACPI_STATUS 164 AcpiNsInitializeObjects ( 165 void); 166 167 ACPI_STATUS 168 AcpiNsInitializeDevices ( 169 void); 170 171 172 /* 173 * nsload - Namespace loading 174 */ 175 ACPI_STATUS 176 AcpiNsLoadNamespace ( 177 void); 178 179 ACPI_STATUS 180 AcpiNsLoadTable ( 181 UINT32 TableIndex, 182 ACPI_NAMESPACE_NODE *Node); 183 184 185 /* 186 * nswalk - walk the namespace 187 */ 188 ACPI_STATUS 189 AcpiNsWalkNamespace ( 190 ACPI_OBJECT_TYPE Type, 191 ACPI_HANDLE StartObject, 192 UINT32 MaxDepth, 193 UINT32 Flags, 194 ACPI_WALK_CALLBACK DescendingCallback, 195 ACPI_WALK_CALLBACK AscendingCallback, 196 void *Context, 197 void **ReturnValue); 198 199 ACPI_NAMESPACE_NODE * 200 AcpiNsGetNextNode ( 201 ACPI_NAMESPACE_NODE *Parent, 202 ACPI_NAMESPACE_NODE *Child); 203 204 ACPI_NAMESPACE_NODE * 205 AcpiNsGetNextNodeTyped ( 206 ACPI_OBJECT_TYPE Type, 207 ACPI_NAMESPACE_NODE *Parent, 208 ACPI_NAMESPACE_NODE *Child); 209 210 /* 211 * nsparse - table parsing 212 */ 213 ACPI_STATUS 214 AcpiNsParseTable ( 215 UINT32 TableIndex, 216 ACPI_NAMESPACE_NODE *StartNode); 217 218 ACPI_STATUS 219 AcpiNsOneCompleteParse ( 220 UINT32 PassNumber, 221 UINT32 TableIndex, 222 ACPI_NAMESPACE_NODE *StartNode); 223 224 225 /* 226 * nsaccess - Top-level namespace access 227 */ 228 ACPI_STATUS 229 AcpiNsRootInitialize ( 230 void); 231 232 ACPI_STATUS 233 AcpiNsLookup ( 234 ACPI_GENERIC_STATE *ScopeInfo, 235 char *Name, 236 ACPI_OBJECT_TYPE Type, 237 ACPI_INTERPRETER_MODE InterpreterMode, 238 UINT32 Flags, 239 ACPI_WALK_STATE *WalkState, 240 ACPI_NAMESPACE_NODE **RetNode); 241 242 243 /* 244 * nsalloc - Named object allocation/deallocation 245 */ 246 ACPI_NAMESPACE_NODE * 247 AcpiNsCreateNode ( 248 UINT32 Name); 249 250 void 251 AcpiNsDeleteNode ( 252 ACPI_NAMESPACE_NODE *Node); 253 254 void 255 AcpiNsRemoveNode ( 256 ACPI_NAMESPACE_NODE *Node); 257 258 void 259 AcpiNsDeleteNamespaceSubtree ( 260 ACPI_NAMESPACE_NODE *ParentHandle); 261 262 void 263 AcpiNsDeleteNamespaceByOwner ( 264 ACPI_OWNER_ID OwnerId); 265 266 void 267 AcpiNsDetachObject ( 268 ACPI_NAMESPACE_NODE *Node); 269 270 void 271 AcpiNsDeleteChildren ( 272 ACPI_NAMESPACE_NODE *Parent); 273 274 int 275 AcpiNsCompareNames ( 276 char *Name1, 277 char *Name2); 278 279 280 /* 281 * nsconvert - Dynamic object conversion routines 282 */ 283 ACPI_STATUS 284 AcpiNsConvertToInteger ( 285 ACPI_OPERAND_OBJECT *OriginalObject, 286 ACPI_OPERAND_OBJECT **ReturnObject); 287 288 ACPI_STATUS 289 AcpiNsConvertToString ( 290 ACPI_OPERAND_OBJECT *OriginalObject, 291 ACPI_OPERAND_OBJECT **ReturnObject); 292 293 ACPI_STATUS 294 AcpiNsConvertToBuffer ( 295 ACPI_OPERAND_OBJECT *OriginalObject, 296 ACPI_OPERAND_OBJECT **ReturnObject); 297 298 ACPI_STATUS 299 AcpiNsConvertToUnicode ( 300 ACPI_NAMESPACE_NODE *Scope, 301 ACPI_OPERAND_OBJECT *OriginalObject, 302 ACPI_OPERAND_OBJECT **ReturnObject); 303 304 ACPI_STATUS 305 AcpiNsConvertToResource ( 306 ACPI_NAMESPACE_NODE *Scope, 307 ACPI_OPERAND_OBJECT *OriginalObject, 308 ACPI_OPERAND_OBJECT **ReturnObject); 309 310 ACPI_STATUS 311 AcpiNsConvertToReference ( 312 ACPI_NAMESPACE_NODE *Scope, 313 ACPI_OPERAND_OBJECT *OriginalObject, 314 ACPI_OPERAND_OBJECT **ReturnObject); 315 316 317 /* 318 * nsdump - Namespace dump/print utilities 319 */ 320 void 321 AcpiNsDumpTables ( 322 ACPI_HANDLE SearchBase, 323 UINT32 MaxDepth); 324 325 void 326 AcpiNsDumpEntry ( 327 ACPI_HANDLE Handle, 328 UINT32 DebugLevel); 329 330 void 331 AcpiNsDumpPathname ( 332 ACPI_HANDLE Handle, 333 char *Msg, 334 UINT32 Level, 335 UINT32 Component); 336 337 void 338 AcpiNsPrintPathname ( 339 UINT32 NumSegments, 340 char *Pathname); 341 342 ACPI_STATUS 343 AcpiNsDumpOneObject ( 344 ACPI_HANDLE ObjHandle, 345 UINT32 Level, 346 void *Context, 347 void **ReturnValue); 348 349 void 350 AcpiNsDumpObjects ( 351 ACPI_OBJECT_TYPE Type, 352 UINT8 DisplayType, 353 UINT32 MaxDepth, 354 ACPI_OWNER_ID OwnerId, 355 ACPI_HANDLE StartHandle); 356 357 void 358 AcpiNsDumpObjectPaths ( 359 ACPI_OBJECT_TYPE Type, 360 UINT8 DisplayType, 361 UINT32 MaxDepth, 362 ACPI_OWNER_ID OwnerId, 363 ACPI_HANDLE StartHandle); 364 365 366 /* 367 * nseval - Namespace evaluation functions 368 */ 369 ACPI_STATUS 370 AcpiNsEvaluate ( 371 ACPI_EVALUATE_INFO *Info); 372 373 void 374 AcpiNsExecModuleCodeList ( 375 void); 376 377 378 /* 379 * nsarguments - Argument count/type checking for predefined/reserved names 380 */ 381 void 382 AcpiNsCheckArgumentCount ( 383 char *Pathname, 384 ACPI_NAMESPACE_NODE *Node, 385 UINT32 UserParamCount, 386 const ACPI_PREDEFINED_INFO *Info); 387 388 void 389 AcpiNsCheckAcpiCompliance ( 390 char *Pathname, 391 ACPI_NAMESPACE_NODE *Node, 392 const ACPI_PREDEFINED_INFO *Predefined); 393 394 void 395 AcpiNsCheckArgumentTypes ( 396 ACPI_EVALUATE_INFO *Info); 397 398 399 /* 400 * nspredef - Return value checking for predefined/reserved names 401 */ 402 ACPI_STATUS 403 AcpiNsCheckReturnValue ( 404 ACPI_NAMESPACE_NODE *Node, 405 ACPI_EVALUATE_INFO *Info, 406 UINT32 UserParamCount, 407 ACPI_STATUS ReturnStatus, 408 ACPI_OPERAND_OBJECT **ReturnObject); 409 410 ACPI_STATUS 411 AcpiNsCheckObjectType ( 412 ACPI_EVALUATE_INFO *Info, 413 ACPI_OPERAND_OBJECT **ReturnObjectPtr, 414 UINT32 ExpectedBtypes, 415 UINT32 PackageIndex); 416 417 418 /* 419 * nsprepkg - Validation of predefined name packages 420 */ 421 ACPI_STATUS 422 AcpiNsCheckPackage ( 423 ACPI_EVALUATE_INFO *Info, 424 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 425 426 427 /* 428 * nsnames - Name and Scope manipulation 429 */ 430 UINT32 431 AcpiNsOpensScope ( 432 ACPI_OBJECT_TYPE Type); 433 434 char * 435 AcpiNsGetExternalPathname ( 436 ACPI_NAMESPACE_NODE *Node); 437 438 UINT32 439 AcpiNsBuildNormalizedPath ( 440 ACPI_NAMESPACE_NODE *Node, 441 char *FullPath, 442 UINT32 PathSize, 443 BOOLEAN NoTrailing); 444 445 char * 446 AcpiNsGetNormalizedPathname ( 447 ACPI_NAMESPACE_NODE *Node, 448 BOOLEAN NoTrailing); 449 450 char * 451 AcpiNsNameOfCurrentScope ( 452 ACPI_WALK_STATE *WalkState); 453 454 ACPI_STATUS 455 AcpiNsHandleToPathname ( 456 ACPI_HANDLE TargetHandle, 457 ACPI_BUFFER *Buffer, 458 BOOLEAN NoTrailing); 459 460 BOOLEAN 461 AcpiNsPatternMatch ( 462 ACPI_NAMESPACE_NODE *ObjNode, 463 char *SearchFor); 464 465 ACPI_STATUS 466 AcpiNsGetNode ( 467 ACPI_NAMESPACE_NODE *PrefixNode, 468 const char *ExternalPathname, 469 UINT32 Flags, 470 ACPI_NAMESPACE_NODE **OutNode); 471 472 ACPI_SIZE 473 AcpiNsGetPathnameLength ( 474 ACPI_NAMESPACE_NODE *Node); 475 476 477 /* 478 * nsobject - Object management for namespace nodes 479 */ 480 ACPI_STATUS 481 AcpiNsAttachObject ( 482 ACPI_NAMESPACE_NODE *Node, 483 ACPI_OPERAND_OBJECT *Object, 484 ACPI_OBJECT_TYPE Type); 485 486 ACPI_OPERAND_OBJECT * 487 AcpiNsGetAttachedObject ( 488 ACPI_NAMESPACE_NODE *Node); 489 490 ACPI_OPERAND_OBJECT * 491 AcpiNsGetSecondaryObject ( 492 ACPI_OPERAND_OBJECT *ObjDesc); 493 494 ACPI_STATUS 495 AcpiNsAttachData ( 496 ACPI_NAMESPACE_NODE *Node, 497 ACPI_OBJECT_HANDLER Handler, 498 void *Data); 499 500 ACPI_STATUS 501 AcpiNsDetachData ( 502 ACPI_NAMESPACE_NODE *Node, 503 ACPI_OBJECT_HANDLER Handler); 504 505 ACPI_STATUS 506 AcpiNsGetAttachedData ( 507 ACPI_NAMESPACE_NODE *Node, 508 ACPI_OBJECT_HANDLER Handler, 509 void **Data); 510 511 512 /* 513 * nsrepair - General return object repair for all 514 * predefined methods/objects 515 */ 516 ACPI_STATUS 517 AcpiNsSimpleRepair ( 518 ACPI_EVALUATE_INFO *Info, 519 UINT32 ExpectedBtypes, 520 UINT32 PackageIndex, 521 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 522 523 ACPI_STATUS 524 AcpiNsWrapWithPackage ( 525 ACPI_EVALUATE_INFO *Info, 526 ACPI_OPERAND_OBJECT *OriginalObject, 527 ACPI_OPERAND_OBJECT **ObjDescPtr); 528 529 ACPI_STATUS 530 AcpiNsRepairNullElement ( 531 ACPI_EVALUATE_INFO *Info, 532 UINT32 ExpectedBtypes, 533 UINT32 PackageIndex, 534 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 535 536 void 537 AcpiNsRemoveNullElements ( 538 ACPI_EVALUATE_INFO *Info, 539 UINT8 PackageType, 540 ACPI_OPERAND_OBJECT *ObjDesc); 541 542 543 /* 544 * nsrepair2 - Return object repair for specific 545 * predefined methods/objects 546 */ 547 ACPI_STATUS 548 AcpiNsComplexRepairs ( 549 ACPI_EVALUATE_INFO *Info, 550 ACPI_NAMESPACE_NODE *Node, 551 ACPI_STATUS ValidateStatus, 552 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 553 554 555 /* 556 * nssearch - Namespace searching and entry 557 */ 558 ACPI_STATUS 559 AcpiNsSearchAndEnter ( 560 UINT32 EntryName, 561 ACPI_WALK_STATE *WalkState, 562 ACPI_NAMESPACE_NODE *Node, 563 ACPI_INTERPRETER_MODE InterpreterMode, 564 ACPI_OBJECT_TYPE Type, 565 UINT32 Flags, 566 ACPI_NAMESPACE_NODE **RetNode); 567 568 ACPI_STATUS 569 AcpiNsSearchOneScope ( 570 UINT32 EntryName, 571 ACPI_NAMESPACE_NODE *Node, 572 ACPI_OBJECT_TYPE Type, 573 ACPI_NAMESPACE_NODE **RetNode); 574 575 void 576 AcpiNsInstallNode ( 577 ACPI_WALK_STATE *WalkState, 578 ACPI_NAMESPACE_NODE *ParentNode, 579 ACPI_NAMESPACE_NODE *Node, 580 ACPI_OBJECT_TYPE Type); 581 582 583 /* 584 * nsutils - Utility functions 585 */ 586 ACPI_OBJECT_TYPE 587 AcpiNsGetType ( 588 ACPI_NAMESPACE_NODE *Node); 589 590 UINT32 591 AcpiNsLocal ( 592 ACPI_OBJECT_TYPE Type); 593 594 void 595 AcpiNsPrintNodePathname ( 596 ACPI_NAMESPACE_NODE *Node, 597 const char *Msg); 598 599 ACPI_STATUS 600 AcpiNsBuildInternalName ( 601 ACPI_NAMESTRING_INFO *Info); 602 603 void 604 AcpiNsGetInternalNameLength ( 605 ACPI_NAMESTRING_INFO *Info); 606 607 ACPI_STATUS 608 AcpiNsInternalizeName ( 609 const char *DottedName, 610 char **ConvertedName); 611 612 ACPI_STATUS 613 AcpiNsExternalizeName ( 614 UINT32 InternalNameLength, 615 const char *InternalName, 616 UINT32 *ConvertedNameLength, 617 char **ConvertedName); 618 619 ACPI_NAMESPACE_NODE * 620 AcpiNsValidateHandle ( 621 ACPI_HANDLE Handle); 622 623 void 624 AcpiNsTerminate ( 625 void); 626 627 #endif /* __ACNAMESP_H__ */ 628