sys/external/intel-public/acpica/dist/include/acnamesp.h

   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 - 2009, 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      UserFunction,
 193     void                    *Context,
 194     void                    **ReturnValue);
 195
 196 ACPI_NAMESPACE_NODE *
 197 AcpiNsGetNextNode (
 198     ACPI_NAMESPACE_NODE     *Parent,
 199     ACPI_NAMESPACE_NODE     *Child);
 200
 201 ACPI_NAMESPACE_NODE *
 202 AcpiNsGetNextNodeTyped (
 203     ACPI_OBJECT_TYPE        Type,
 204     ACPI_NAMESPACE_NODE     *Parent,
 205     ACPI_NAMESPACE_NODE     *Child);
 206
 207 /*
 208  * nsparse - table parsing
 209  */
 210 ACPI_STATUS
 211 AcpiNsParseTable (
 212     UINT32                  TableIndex,
 213     ACPI_NAMESPACE_NODE     *StartNode);
 214
 215 ACPI_STATUS
 216 AcpiNsOneCompleteParse (
 217     UINT32                  PassNumber,
 218     UINT32                  TableIndex,
 219     ACPI_NAMESPACE_NODE     *StartNode);
 220
 221
 222 /*
 223  * nsaccess - Top-level namespace access
 224  */
 225 ACPI_STATUS
 226 AcpiNsRootInitialize (
 227     void);
 228
 229 ACPI_STATUS
 230 AcpiNsLookup (
 231     ACPI_GENERIC_STATE      *ScopeInfo,
 232     char                    *Name,
 233     ACPI_OBJECT_TYPE        Type,
 234     ACPI_INTERPRETER_MODE   InterpreterMode,
 235     UINT32                  Flags,
 236     ACPI_WALK_STATE         *WalkState,
 237     ACPI_NAMESPACE_NODE     **RetNode);
 238
 239
 240 /*
 241  * nsalloc - Named object allocation/deallocation
 242  */
 243 ACPI_NAMESPACE_NODE *
 244 AcpiNsCreateNode (
 245     UINT32                  Name);
 246
 247 void
 248 AcpiNsDeleteNode (
 249     ACPI_NAMESPACE_NODE     *Node);
 250
 251 void
 252 AcpiNsRemoveNode (
 253     ACPI_NAMESPACE_NODE     *Node);
 254
 255 void
 256 AcpiNsDeleteNamespaceSubtree (
 257     ACPI_NAMESPACE_NODE     *ParentHandle);
 258
 259 void
 260 AcpiNsDeleteNamespaceByOwner (
 261     ACPI_OWNER_ID           OwnerId);
 262
 263 void
 264 AcpiNsDetachObject (
 265     ACPI_NAMESPACE_NODE     *Node);
 266
 267 void
 268 AcpiNsDeleteChildren (
 269     ACPI_NAMESPACE_NODE     *Parent);
 270
 271 int
 272 AcpiNsCompareNames (
 273     char                    *Name1,
 274     char                    *Name2);
 275
 276
 277 /*
 278  * nsdump - Namespace dump/print utilities
 279  */
 280 void
 281 AcpiNsDumpTables (
 282     ACPI_HANDLE             SearchBase,
 283     UINT32                  MaxDepth);
 284
 285 void
 286 AcpiNsDumpEntry (
 287     ACPI_HANDLE             Handle,
 288     UINT32                  DebugLevel);
 289
 290 void
 291 AcpiNsDumpPathname (
 292     ACPI_HANDLE             Handle,
 293     const char              *Msg,
 294     UINT32                  Level,
 295     UINT32                  Component);
 296
 297 void
 298 AcpiNsPrintPathname (
 299     UINT32                  NumSegments,
 300     char                    *Pathname);
 301
 302 ACPI_STATUS
 303 AcpiNsDumpOneObject (
 304     ACPI_HANDLE             ObjHandle,
 305     UINT32                  Level,
 306     void                    *Context,
 307     void                    **ReturnValue);
 308
 309 void
 310 AcpiNsDumpObjects (
 311     ACPI_OBJECT_TYPE        Type,
 312     UINT8                   DisplayType,
 313     UINT32                  MaxDepth,
 314     ACPI_OWNER_ID           OwnerId,
 315     ACPI_HANDLE             StartHandle);
 316
 317
 318 /*
 319  * nseval - Namespace evaluation functions
 320  */
 321 ACPI_STATUS
 322 AcpiNsEvaluate (
 323     ACPI_EVALUATE_INFO      *Info);
 324
 325 void
 326 AcpiNsExecModuleCodeList (
 327     void);
 328
 329
 330 /*
 331  * nspredef - Support for predefined/reserved names
 332  */
 333 ACPI_STATUS
 334 AcpiNsCheckPredefinedNames (
 335     ACPI_NAMESPACE_NODE     *Node,
 336     UINT32                  UserParamCount,
 337     ACPI_STATUS             ReturnStatus,
 338     ACPI_OPERAND_OBJECT     **ReturnObject);
 339
 340 const ACPI_PREDEFINED_INFO *
 341 AcpiNsCheckForPredefinedName (
 342     ACPI_NAMESPACE_NODE     *Node);
 343
 344 void
 345 AcpiNsCheckParameterCount (
 346     char                        *Pathname,
 347     ACPI_NAMESPACE_NODE         *Node,
 348     UINT32                      UserParamCount,
 349     const ACPI_PREDEFINED_INFO  *Info);
 350
 351
 352 /*
 353  * nsnames - Name and Scope manipulation
 354  */
 355 UINT32
 356 AcpiNsOpensScope (
 357     ACPI_OBJECT_TYPE        Type);
 358
 359 ACPI_STATUS
 360 AcpiNsBuildExternalPath (
 361     ACPI_NAMESPACE_NODE     *Node,
 362     ACPI_SIZE               Size,
 363     char                    *NameBuffer);
 364
 365 char *
 366 AcpiNsGetExternalPathname (
 367     ACPI_NAMESPACE_NODE     *Node);
 368
 369 char *
 370 AcpiNsNameOfCurrentScope (
 371     ACPI_WALK_STATE         *WalkState);
 372
 373 ACPI_STATUS
 374 AcpiNsHandleToPathname (
 375     ACPI_HANDLE             TargetHandle,
 376     ACPI_BUFFER             *Buffer);
 377
 378 BOOLEAN
 379 AcpiNsPatternMatch (
 380     ACPI_NAMESPACE_NODE     *ObjNode,
 381     char                    *SearchFor);
 382
 383 ACPI_STATUS
 384 AcpiNsGetNode (
 385     ACPI_NAMESPACE_NODE     *PrefixNode,
 386     const char              *ExternalPathname,
 387     UINT32                  Flags,
 388     ACPI_NAMESPACE_NODE     **OutNode);
 389
 390 ACPI_SIZE
 391 AcpiNsGetPathnameLength (
 392     ACPI_NAMESPACE_NODE     *Node);
 393
 394
 395 /*
 396  * nsobject - Object management for namespace nodes
 397  */
 398 ACPI_STATUS
 399 AcpiNsAttachObject (
 400     ACPI_NAMESPACE_NODE     *Node,
 401     ACPI_OPERAND_OBJECT     *Object,
 402     ACPI_OBJECT_TYPE        Type);
 403
 404 ACPI_OPERAND_OBJECT *
 405 AcpiNsGetAttachedObject (
 406     ACPI_NAMESPACE_NODE     *Node);
 407
 408 ACPI_OPERAND_OBJECT *
 409 AcpiNsGetSecondaryObject (
 410     ACPI_OPERAND_OBJECT     *ObjDesc);
 411
 412 ACPI_STATUS
 413 AcpiNsAttachData (
 414     ACPI_NAMESPACE_NODE     *Node,
 415     ACPI_OBJECT_HANDLER     Handler,
 416     void                    *Data);
 417
 418 ACPI_STATUS
 419 AcpiNsDetachData (
 420     ACPI_NAMESPACE_NODE     *Node,
 421     ACPI_OBJECT_HANDLER     Handler);
 422
 423 ACPI_STATUS
 424 AcpiNsGetAttachedData (
 425     ACPI_NAMESPACE_NODE     *Node,
 426     ACPI_OBJECT_HANDLER     Handler,
 427     void                    **Data);
 428
 429
 430 /*
 431  * nsrepair - return object repair for predefined methods/objects
 432  */
 433 ACPI_STATUS
 434 AcpiNsRepairObject (
 435     ACPI_PREDEFINED_DATA    *Data,
 436     UINT32                  ExpectedBtypes,
 437     UINT32                  PackageIndex,
 438     ACPI_OPERAND_OBJECT     **ReturnObjectPtr);
 439
 440 ACPI_STATUS
 441 AcpiNsRepairPackageList (
 442     ACPI_PREDEFINED_DATA    *Data,
 443     ACPI_OPERAND_OBJECT     **ObjDescPtr);
 444
 445
 446 /*
 447  * nssearch - Namespace searching and entry
 448  */
 449 ACPI_STATUS
 450 AcpiNsSearchAndEnter (
 451     UINT32                  EntryName,
 452     ACPI_WALK_STATE         *WalkState,
 453     ACPI_NAMESPACE_NODE     *Node,
 454     ACPI_INTERPRETER_MODE   InterpreterMode,
 455     ACPI_OBJECT_TYPE        Type,
 456     UINT32                  Flags,
 457     ACPI_NAMESPACE_NODE     **RetNode);
 458
 459 ACPI_STATUS
 460 AcpiNsSearchOneScope (
 461     UINT32                  EntryName,
 462     ACPI_NAMESPACE_NODE     *Node,
 463     ACPI_OBJECT_TYPE        Type,
 464     ACPI_NAMESPACE_NODE     **RetNode);
 465
 466 void
 467 AcpiNsInstallNode (
 468     ACPI_WALK_STATE         *WalkState,
 469     ACPI_NAMESPACE_NODE     *ParentNode,
 470     ACPI_NAMESPACE_NODE     *Node,
 471     ACPI_OBJECT_TYPE        Type);
 472
 473
 474 /*
 475  * nsutils - Utility functions
 476  */
 477 BOOLEAN
 478 AcpiNsValidRootPrefix (
 479     char                    Prefix);
 480
 481 ACPI_OBJECT_TYPE
 482 AcpiNsGetType (
 483     ACPI_NAMESPACE_NODE     *Node);
 484
 485 UINT32
 486 AcpiNsLocal (
 487     ACPI_OBJECT_TYPE        Type);
 488
 489 void
 490 AcpiNsReportError (
 491     const char              *ModuleName,
 492     UINT32                  LineNumber,
 493     const char              *InternalName,
 494     ACPI_STATUS             LookupStatus);
 495
 496 void
 497 AcpiNsReportMethodError (
 498     const char              *ModuleName,
 499     UINT32                  LineNumber,
 500     const char              *Message,
 501     ACPI_NAMESPACE_NODE     *Node,
 502     const char              *Path,
 503     ACPI_STATUS             LookupStatus);
 504
 505 void
 506 AcpiNsPrintNodePathname (
 507     ACPI_NAMESPACE_NODE     *Node,
 508     const char              *Msg);
 509
 510 ACPI_STATUS
 511 AcpiNsBuildInternalName (
 512     ACPI_NAMESTRING_INFO    *Info);
 513
 514 void
 515 AcpiNsGetInternalNameLength (
 516     ACPI_NAMESTRING_INFO    *Info);
 517
 518 ACPI_STATUS
 519 AcpiNsInternalizeName (
 520     const char              *DottedName,
 521     char                    **ConvertedName);
 522
 523 ACPI_STATUS
 524 AcpiNsExternalizeName (
 525     UINT32                  InternalNameLength,
 526     const char              *InternalName,
 527     UINT32                  *ConvertedNameLength,
 528     char                    **ConvertedName);
 529
 530 ACPI_NAMESPACE_NODE *
 531 AcpiNsMapHandleToNode (
 532     ACPI_HANDLE             Handle);
 533
 534 ACPI_HANDLE
 535 AcpiNsConvertEntryToHandle(
 536     ACPI_NAMESPACE_NODE     *Node);
 537
 538 void
 539 AcpiNsTerminate (
 540     void);
 541
 542 ACPI_NAMESPACE_NODE *
 543 AcpiNsGetParentNode (
 544     ACPI_NAMESPACE_NODE     *Node);
 545
 546
 547 ACPI_NAMESPACE_NODE *
 548 AcpiNsGetNextValidNode (
 549     ACPI_NAMESPACE_NODE     *Node);
 550
 551 #endif /* __ACNAMESP_H__ */