sys/contrib/dev/acpica-unix-20031203/include/acnamesp.h

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