sys/contrib/dev/acpica/acnamesp.h

   1 /******************************************************************************
   2  *
   3  * Name: acnamesp.h - Namespace subcomponent prototypes and defines
   4  *       $Revision: 133 $
   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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acnamesp.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118 #ifndef __ACNAMESP_H__
 119 #define __ACNAMESP_H__
 120
 121
 122 /* To search the entire name space, pass this as SearchBase */
 123
 124 #define ACPI_NS_ALL                 ((ACPI_HANDLE)0)
 125
 126 /*
 127  * Elements of AcpiNsProperties are bit significant
 128  * and should be one-to-one with values of ACPI_OBJECT_TYPE
 129  */
 130 #define ACPI_NS_NORMAL              0
 131 #define ACPI_NS_NEWSCOPE            1   /* a definition of this type opens a name scope */
 132 #define ACPI_NS_LOCAL               2   /* suppress search of enclosing scopes */
 133
 134
 135 /* Definitions of the predefined namespace names  */
 136
 137 #define ACPI_UNKNOWN_NAME           (UINT32) 0x3F3F3F3F     /* Unknown name is  "????" */
 138 #define ACPI_ROOT_NAME              (UINT32) 0x5F5F5F5C     /* Root name is     "\___" */
 139 #define ACPI_SYS_BUS_NAME           (UINT32) 0x5F53425F     /* Sys bus name is  "_SB_" */
 140
 141 #define ACPI_NS_ROOT_PATH           "\\"
 142 #define ACPI_NS_SYSTEM_BUS          "_SB_"
 143
 144
 145 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
 146
 147 #define ACPI_NS_NO_UPSEARCH         0
 148 #define ACPI_NS_SEARCH_PARENT       0x01
 149 #define ACPI_NS_DONT_OPEN_SCOPE     0x02
 150 #define ACPI_NS_NO_PEER_SEARCH      0x04
 151 #define ACPI_NS_ERROR_IF_FOUND      0x08
 152
 153 #define ACPI_NS_WALK_UNLOCK         TRUE
 154 #define ACPI_NS_WALK_NO_UNLOCK      FALSE
 155
 156
 157 ACPI_STATUS
 158 AcpiNsLoadNamespace (
 159     void);
 160
 161 ACPI_STATUS
 162 AcpiNsInitializeObjects (
 163     void);
 164
 165 ACPI_STATUS
 166 AcpiNsInitializeDevices (
 167     void);
 168
 169
 170 /* Namespace init - nsxfinit */
 171
 172 ACPI_STATUS
 173 AcpiNsInitOneDevice (
 174     ACPI_HANDLE             ObjHandle,
 175     UINT32                  NestingLevel,
 176     void                    *Context,
 177     void                    **ReturnValue);
 178
 179 ACPI_STATUS
 180 AcpiNsInitOneObject (
 181     ACPI_HANDLE             ObjHandle,
 182     UINT32                  Level,
 183     void                    *Context,
 184     void                    **ReturnValue);
 185
 186
 187 ACPI_STATUS
 188 AcpiNsWalkNamespace (
 189     ACPI_OBJECT_TYPE        Type,
 190     ACPI_HANDLE             StartObject,
 191     UINT32                  MaxDepth,
 192     BOOLEAN                 UnlockBeforeCallback,
 193     ACPI_WALK_CALLBACK      UserFunction,
 194     void                    *Context,
 195     void                    **ReturnValue);
 196
 197 ACPI_NAMESPACE_NODE *
 198 AcpiNsGetNextNode (
 199     ACPI_OBJECT_TYPE        Type,
 200     ACPI_NAMESPACE_NODE     *Parent,
 201     ACPI_NAMESPACE_NODE     *Child);
 202
 203 void
 204 AcpiNsDeleteNamespaceByOwner (
 205     UINT16                  TableId);
 206
 207
 208 /* Namespace loading - nsload */
 209
 210 ACPI_STATUS
 211 AcpiNsOneCompleteParse (
 212     UINT32                  PassNumber,
 213     ACPI_TABLE_DESC         *TableDesc);
 214
 215 ACPI_STATUS
 216 AcpiNsParseTable (
 217     ACPI_TABLE_DESC         *TableDesc,
 218     ACPI_NAMESPACE_NODE     *Scope);
 219
 220 ACPI_STATUS
 221 AcpiNsLoadTable (
 222     ACPI_TABLE_DESC         *TableDesc,
 223     ACPI_NAMESPACE_NODE     *Node);
 224
 225 ACPI_STATUS
 226 AcpiNsLoadTableByType (
 227     ACPI_TABLE_TYPE         TableType);
 228
 229
 230 /*
 231  * Top-level namespace access - nsaccess
 232  */
 233
 234 ACPI_STATUS
 235 AcpiNsRootInitialize (
 236     void);
 237
 238 ACPI_STATUS
 239 AcpiNsLookup (
 240     ACPI_GENERIC_STATE      *ScopeInfo,
 241     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 ACPI_NAMESPACE_NODE *
 254 AcpiNsCreateNode (
 255     UINT32                  Name);
 256
 257 void
 258 AcpiNsDeleteNode (
 259     ACPI_NAMESPACE_NODE     *Node);
 260
 261 void
 262 AcpiNsDeleteNamespaceSubtree (
 263     ACPI_NAMESPACE_NODE     *ParentHandle);
 264
 265 void
 266 AcpiNsDetachObject (
 267     ACPI_NAMESPACE_NODE     *Node);
 268
 269 void
 270 AcpiNsDeleteChildren (
 271     ACPI_NAMESPACE_NODE     *Parent);
 272
 273 int
 274 AcpiNsCompareNames (
 275     char                    *Name1,
 276     char                    *Name2);
 277
 278 /*
 279  * Namespace modification - nsmodify
 280  */
 281
 282 ACPI_STATUS
 283 AcpiNsUnloadNamespace (
 284     ACPI_HANDLE             Handle);
 285
 286 ACPI_STATUS
 287 AcpiNsDeleteSubtree (
 288     ACPI_HANDLE             StartHandle);
 289
 290
 291 /*
 292  * Namespace dump/print utilities - nsdump
 293  */
 294
 295 void
 296 AcpiNsDumpTables (
 297     ACPI_HANDLE             SearchBase,
 298     UINT32                  MaxDepth);
 299
 300 void
 301 AcpiNsDumpEntry (
 302     ACPI_HANDLE             Handle,
 303     UINT32                  DebugLevel);
 304
 305 void
 306 AcpiNsDumpPathname (
 307     ACPI_HANDLE             Handle,
 308     char                    *Msg,
 309     UINT32                  Level,
 310     UINT32                  Component);
 311
 312 void
 313 AcpiNsPrintPathname (
 314     UINT32                  NumSegments,
 315     char                    *Pathname);
 316
 317 ACPI_STATUS
 318 AcpiNsDumpOneDevice (
 319     ACPI_HANDLE             ObjHandle,
 320     UINT32                  Level,
 321     void                    *Context,
 322     void                    **ReturnValue);
 323
 324 void
 325 AcpiNsDumpRootDevices (
 326     void);
 327
 328 ACPI_STATUS
 329 AcpiNsDumpOneObject (
 330     ACPI_HANDLE             ObjHandle,
 331     UINT32                  Level,
 332     void                    *Context,
 333     void                    **ReturnValue);
 334
 335 void
 336 AcpiNsDumpObjects (
 337     ACPI_OBJECT_TYPE        Type,
 338     UINT8                   DisplayType,
 339     UINT32                  MaxDepth,
 340     UINT32                  OwnderId,
 341     ACPI_HANDLE             StartHandle);
 342
 343
 344 /*
 345  * Namespace evaluation functions - nseval
 346  */
 347
 348 ACPI_STATUS
 349 AcpiNsEvaluateByHandle (
 350     ACPI_NAMESPACE_NODE     *PrefixNode,
 351     ACPI_OPERAND_OBJECT     **Params,
 352     ACPI_OPERAND_OBJECT     **ReturnObject);
 353
 354 ACPI_STATUS
 355 AcpiNsEvaluateByName (
 356     char                    *Pathname,
 357     ACPI_OPERAND_OBJECT     **Params,
 358     ACPI_OPERAND_OBJECT     **ReturnObject);
 359
 360 ACPI_STATUS
 361 AcpiNsEvaluateRelative (
 362     ACPI_NAMESPACE_NODE     *PrefixNode,
 363     char                    *Pathname,
 364     ACPI_OPERAND_OBJECT     **Params,
 365     ACPI_OPERAND_OBJECT     **ReturnObject);
 366
 367 ACPI_STATUS
 368 AcpiNsExecuteControlMethod (
 369     ACPI_NAMESPACE_NODE     *MethodNode,
 370     ACPI_OPERAND_OBJECT     **Params,
 371     ACPI_OPERAND_OBJECT     **ReturnObjDesc);
 372
 373 ACPI_STATUS
 374 AcpiNsGetObjectValue (
 375     ACPI_NAMESPACE_NODE     *ObjectNode,
 376     ACPI_OPERAND_OBJECT     **ReturnObjDesc);
 377
 378
 379 /*
 380  * Parent/Child/Peer utility functions
 381  */
 382
 383 ACPI_NAME
 384 AcpiNsFindParentName (
 385     ACPI_NAMESPACE_NODE     *NodeToSearch);
 386
 387
 388 /*
 389  * Name and Scope manipulation - nsnames
 390  */
 391
 392 UINT32
 393 AcpiNsOpensScope (
 394     ACPI_OBJECT_TYPE        Type);
 395
 396 void
 397 AcpiNsBuildExternalPath (
 398     ACPI_NAMESPACE_NODE     *Node,
 399     ACPI_SIZE               Size,
 400     char                    *NameBuffer);
 401
 402 char *
 403 AcpiNsGetExternalPathname (
 404     ACPI_NAMESPACE_NODE     *Node);
 405
 406 char *
 407 AcpiNsNameOfCurrentScope (
 408     ACPI_WALK_STATE         *WalkState);
 409
 410 ACPI_STATUS
 411 AcpiNsHandleToPathname (
 412     ACPI_HANDLE             TargetHandle,
 413     ACPI_BUFFER             *Buffer);
 414
 415 BOOLEAN
 416 AcpiNsPatternMatch (
 417     ACPI_NAMESPACE_NODE     *ObjNode,
 418     char                    *SearchFor);
 419
 420 ACPI_STATUS
 421 AcpiNsGetNodeByPath (
 422     char                    *ExternalPathname,
 423     ACPI_NAMESPACE_NODE     *InPrefixNode,
 424     UINT32                  Flags,
 425     ACPI_NAMESPACE_NODE     **OutNode);
 426
 427 ACPI_SIZE
 428 AcpiNsGetPathnameLength (
 429     ACPI_NAMESPACE_NODE     *Node);
 430
 431
 432 /*
 433  * Object management for namespace nodes - nsobject
 434  */
 435
 436 ACPI_STATUS
 437 AcpiNsAttachObject (
 438     ACPI_NAMESPACE_NODE     *Node,
 439     ACPI_OPERAND_OBJECT     *Object,
 440     ACPI_OBJECT_TYPE        Type);
 441
 442 ACPI_OPERAND_OBJECT *
 443 AcpiNsGetAttachedObject (
 444     ACPI_NAMESPACE_NODE     *Node);
 445
 446 ACPI_OPERAND_OBJECT *
 447 AcpiNsGetSecondaryObject (
 448     ACPI_OPERAND_OBJECT     *ObjDesc);
 449
 450 ACPI_STATUS
 451 AcpiNsAttachData (
 452     ACPI_NAMESPACE_NODE     *Node,
 453     ACPI_OBJECT_HANDLER     Handler,
 454     void                    *Data);
 455
 456 ACPI_STATUS
 457 AcpiNsDetachData (
 458     ACPI_NAMESPACE_NODE     *Node,
 459     ACPI_OBJECT_HANDLER     Handler);
 460
 461 ACPI_STATUS
 462 AcpiNsGetAttachedData (
 463     ACPI_NAMESPACE_NODE     *Node,
 464     ACPI_OBJECT_HANDLER     Handler,
 465     void                    **Data);
 466
 467
 468 /*
 469  * Namespace searching and entry - nssearch
 470  */
 471
 472 ACPI_STATUS
 473 AcpiNsSearchAndEnter (
 474     UINT32                  EntryName,
 475     ACPI_WALK_STATE         *WalkState,
 476     ACPI_NAMESPACE_NODE     *Node,
 477     ACPI_INTERPRETER_MODE   InterpreterMode,
 478     ACPI_OBJECT_TYPE        Type,
 479     UINT32                  Flags,
 480     ACPI_NAMESPACE_NODE     **RetNode);
 481
 482 ACPI_STATUS
 483 AcpiNsSearchNode (
 484     UINT32                  EntryName,
 485     ACPI_NAMESPACE_NODE     *Node,
 486     ACPI_OBJECT_TYPE        Type,
 487     ACPI_NAMESPACE_NODE     **RetNode);
 488
 489 void
 490 AcpiNsInstallNode (
 491     ACPI_WALK_STATE         *WalkState,
 492     ACPI_NAMESPACE_NODE     *ParentNode,
 493     ACPI_NAMESPACE_NODE     *Node,
 494     ACPI_OBJECT_TYPE        Type);
 495
 496
 497 /*
 498  * Utility functions - nsutils
 499  */
 500
 501 BOOLEAN
 502 AcpiNsValidRootPrefix (
 503     char                    Prefix);
 504
 505 BOOLEAN
 506 AcpiNsValidPathSeparator (
 507     char                    Sep);
 508
 509 ACPI_OBJECT_TYPE
 510 AcpiNsGetType (
 511     ACPI_NAMESPACE_NODE     *Node);
 512
 513 UINT32
 514 AcpiNsLocal (
 515     ACPI_OBJECT_TYPE        Type);
 516
 517 void
 518 AcpiNsReportError (
 519     char                    *ModuleName,
 520     UINT32                  LineNumber,
 521     UINT32                  ComponentId,
 522     char                    *InternalName,
 523     ACPI_STATUS             LookupStatus);
 524
 525 void
 526 AcpiNsReportMethodError (
 527     char                    *ModuleName,
 528     UINT32                  LineNumber,
 529     UINT32                  ComponentId,
 530     char                    *Message,
 531     ACPI_NAMESPACE_NODE     *Node,
 532     char                    *Path,
 533     ACPI_STATUS             LookupStatus);
 534
 535 void
 536 AcpiNsPrintNodePathname (
 537     ACPI_NAMESPACE_NODE     *Node,
 538     char                    *Msg);
 539
 540 ACPI_STATUS
 541 AcpiNsBuildInternalName (
 542     ACPI_NAMESTRING_INFO    *Info);
 543
 544 void
 545 AcpiNsGetInternalNameLength (
 546     ACPI_NAMESTRING_INFO    *Info);
 547
 548 ACPI_STATUS
 549 AcpiNsInternalizeName (
 550     char                    *DottedName,
 551     char                    **ConvertedName);
 552
 553 ACPI_STATUS
 554 AcpiNsExternalizeName (
 555     UINT32                  InternalNameLength,
 556     char                    *InternalName,
 557     UINT32                  *ConvertedNameLength,
 558     char                    **ConvertedName);
 559
 560 ACPI_NAMESPACE_NODE *
 561 AcpiNsMapHandleToNode (
 562     ACPI_HANDLE             Handle);
 563
 564 ACPI_HANDLE
 565 AcpiNsConvertEntryToHandle(
 566     ACPI_NAMESPACE_NODE     *Node);
 567
 568 void
 569 AcpiNsTerminate (
 570     void);
 571
 572 ACPI_NAMESPACE_NODE *
 573 AcpiNsGetParentNode (
 574     ACPI_NAMESPACE_NODE     *Node);
 575
 576
 577 ACPI_NAMESPACE_NODE *
 578 AcpiNsGetNextValidNode (
 579     ACPI_NAMESPACE_NODE     *Node);
 580
 581
 582 #endif /* __ACNAMESP_H__ */