587 lines
16 KiB
C
587 lines
16 KiB
C
/******************************************************************************
|
|
*
|
|
* Name: acnamesp.h - Namespace subcomponent prototypes and defines
|
|
* $Revision: 135 $
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/******************************************************************************
|
|
*
|
|
* 1. Copyright Notice
|
|
*
|
|
* Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
|
|
* All rights reserved.
|
|
*
|
|
* 2. License
|
|
*
|
|
* 2.1. This is your license from Intel Corp. under its intellectual property
|
|
* rights. You may have additional license terms from the party that provided
|
|
* you this software, covering your right to use that party's intellectual
|
|
* property rights.
|
|
*
|
|
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
|
|
* copy of the source code appearing in this file ("Covered Code") an
|
|
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
|
|
* base code distributed originally by Intel ("Original Intel Code") to copy,
|
|
* make derivatives, distribute, use and display any portion of the Covered
|
|
* Code in any form, with the right to sublicense such rights; and
|
|
*
|
|
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
|
|
* license (with the right to sublicense), under only those claims of Intel
|
|
* patents that are infringed by the Original Intel Code, to make, use, sell,
|
|
* offer to sell, and import the Covered Code and derivative works thereof
|
|
* solely to the minimum extent necessary to exercise the above copyright
|
|
* license, and in no event shall the patent license extend to any additions
|
|
* to or modifications of the Original Intel Code. No other license or right
|
|
* is granted directly or by implication, estoppel or otherwise;
|
|
*
|
|
* The above copyright and patent license is granted only if the following
|
|
* conditions are met:
|
|
*
|
|
* 3. Conditions
|
|
*
|
|
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
|
|
* Redistribution of source code of any substantial portion of the Covered
|
|
* Code or modification with rights to further distribute source must include
|
|
* the above Copyright Notice, the above License, this list of Conditions,
|
|
* and the following Disclaimer and Export Compliance provision. In addition,
|
|
* Licensee must cause all Covered Code to which Licensee contributes to
|
|
* contain a file documenting the changes Licensee made to create that Covered
|
|
* Code and the date of any change. Licensee must include in that file the
|
|
* documentation of any changes made by any predecessor Licensee. Licensee
|
|
* must include a prominent statement that the modification is derived,
|
|
* directly or indirectly, from Original Intel Code.
|
|
*
|
|
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
|
|
* Redistribution of source code of any substantial portion of the Covered
|
|
* Code or modification without rights to further distribute source must
|
|
* include the following Disclaimer and Export Compliance provision in the
|
|
* documentation and/or other materials provided with distribution. In
|
|
* addition, Licensee may not authorize further sublicense of source of any
|
|
* portion of the Covered Code, and must include terms to the effect that the
|
|
* license from Licensee to its licensee is limited to the intellectual
|
|
* property embodied in the software Licensee provides to its licensee, and
|
|
* not to intellectual property embodied in modifications its licensee may
|
|
* make.
|
|
*
|
|
* 3.3. Redistribution of Executable. Redistribution in executable form of any
|
|
* substantial portion of the Covered Code or modification must reproduce the
|
|
* above Copyright Notice, and the following Disclaimer and Export Compliance
|
|
* provision in the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3.4. Intel retains all right, title, and interest in and to the Original
|
|
* Intel Code.
|
|
*
|
|
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
|
|
* Intel shall be used in advertising or otherwise to promote the sale, use or
|
|
* other dealings in products derived from or relating to the Covered Code
|
|
* without prior written authorization from Intel.
|
|
*
|
|
* 4. Disclaimer and Export Compliance
|
|
*
|
|
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
|
|
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
|
|
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
|
|
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
|
|
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
|
|
* PARTICULAR PURPOSE.
|
|
*
|
|
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
|
|
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
|
|
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
|
|
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
|
|
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
|
|
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
|
|
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
|
|
* LIMITED REMEDY.
|
|
*
|
|
* 4.3. Licensee shall not export, either directly or indirectly, any of this
|
|
* software or system incorporating such software without first obtaining any
|
|
* required license or other approval from the U. S. Department of Commerce or
|
|
* any other agency or department of the United States Government. In the
|
|
* event Licensee exports any such software from the United States or
|
|
* re-exports any such software from a foreign destination, Licensee shall
|
|
* ensure that the distribution and export/re-export of the software is in
|
|
* compliance with all laws, regulations, orders, or other restrictions of the
|
|
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
|
|
* any of its subsidiaries will export/re-export any technical data, process,
|
|
* software, or service, directly or indirectly, to any country for which the
|
|
* United States government or any agency thereof requires an export license,
|
|
* other governmental approval, or letter of assurance, without first obtaining
|
|
* such license, approval or letter.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
#ifndef __ACNAMESP_H__
|
|
#define __ACNAMESP_H__
|
|
|
|
|
|
/* To search the entire name space, pass this as SearchBase */
|
|
|
|
#define ACPI_NS_ALL ((ACPI_HANDLE)0)
|
|
|
|
/*
|
|
* Elements of AcpiNsProperties are bit significant
|
|
* and should be one-to-one with values of ACPI_OBJECT_TYPE
|
|
*/
|
|
#define ACPI_NS_NORMAL 0
|
|
#define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
|
|
#define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
|
|
|
|
|
|
/* Definitions of the predefined namespace names */
|
|
|
|
#define ACPI_UNKNOWN_NAME (UINT32) 0x3F3F3F3F /* Unknown name is "????" */
|
|
#define ACPI_ROOT_NAME (UINT32) 0x5F5F5F5C /* Root name is "\___" */
|
|
#define ACPI_SYS_BUS_NAME (UINT32) 0x5F53425F /* Sys bus name is "_SB_" */
|
|
|
|
#define ACPI_NS_ROOT_PATH "\\"
|
|
#define ACPI_NS_SYSTEM_BUS "_SB_"
|
|
|
|
|
|
/* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
|
|
|
|
#define ACPI_NS_NO_UPSEARCH 0
|
|
#define ACPI_NS_SEARCH_PARENT 0x01
|
|
#define ACPI_NS_DONT_OPEN_SCOPE 0x02
|
|
#define ACPI_NS_NO_PEER_SEARCH 0x04
|
|
#define ACPI_NS_ERROR_IF_FOUND 0x08
|
|
|
|
#define ACPI_NS_WALK_UNLOCK TRUE
|
|
#define ACPI_NS_WALK_NO_UNLOCK FALSE
|
|
|
|
|
|
ACPI_STATUS
|
|
AcpiNsLoadNamespace (
|
|
void);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsInitializeObjects (
|
|
void);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsInitializeDevices (
|
|
void);
|
|
|
|
|
|
/* Namespace init - nsxfinit */
|
|
|
|
ACPI_STATUS
|
|
AcpiNsInitOneDevice (
|
|
ACPI_HANDLE ObjHandle,
|
|
UINT32 NestingLevel,
|
|
void *Context,
|
|
void **ReturnValue);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsInitOneObject (
|
|
ACPI_HANDLE ObjHandle,
|
|
UINT32 Level,
|
|
void *Context,
|
|
void **ReturnValue);
|
|
|
|
|
|
ACPI_STATUS
|
|
AcpiNsWalkNamespace (
|
|
ACPI_OBJECT_TYPE Type,
|
|
ACPI_HANDLE StartObject,
|
|
UINT32 MaxDepth,
|
|
BOOLEAN UnlockBeforeCallback,
|
|
ACPI_WALK_CALLBACK UserFunction,
|
|
void *Context,
|
|
void **ReturnValue);
|
|
|
|
ACPI_NAMESPACE_NODE *
|
|
AcpiNsGetNextNode (
|
|
ACPI_OBJECT_TYPE Type,
|
|
ACPI_NAMESPACE_NODE *Parent,
|
|
ACPI_NAMESPACE_NODE *Child);
|
|
|
|
void
|
|
AcpiNsDeleteNamespaceByOwner (
|
|
UINT16 TableId);
|
|
|
|
|
|
/* Namespace loading - nsload */
|
|
|
|
ACPI_STATUS
|
|
AcpiNsOneCompleteParse (
|
|
UINT32 PassNumber,
|
|
ACPI_TABLE_DESC *TableDesc);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsParseTable (
|
|
ACPI_TABLE_DESC *TableDesc,
|
|
ACPI_NAMESPACE_NODE *Scope);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsLoadTable (
|
|
ACPI_TABLE_DESC *TableDesc,
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsLoadTableByType (
|
|
ACPI_TABLE_TYPE TableType);
|
|
|
|
|
|
/*
|
|
* Top-level namespace access - nsaccess
|
|
*/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsRootInitialize (
|
|
void);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsLookup (
|
|
ACPI_GENERIC_STATE *ScopeInfo,
|
|
char *Name,
|
|
ACPI_OBJECT_TYPE Type,
|
|
ACPI_INTERPRETER_MODE InterpreterMode,
|
|
UINT32 Flags,
|
|
ACPI_WALK_STATE *WalkState,
|
|
ACPI_NAMESPACE_NODE **RetNode);
|
|
|
|
|
|
/*
|
|
* Named object allocation/deallocation - nsalloc
|
|
*/
|
|
|
|
ACPI_NAMESPACE_NODE *
|
|
AcpiNsCreateNode (
|
|
UINT32 Name);
|
|
|
|
void
|
|
AcpiNsDeleteNode (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
void
|
|
AcpiNsDeleteNamespaceSubtree (
|
|
ACPI_NAMESPACE_NODE *ParentHandle);
|
|
|
|
void
|
|
AcpiNsDetachObject (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
void
|
|
AcpiNsDeleteChildren (
|
|
ACPI_NAMESPACE_NODE *Parent);
|
|
|
|
int
|
|
AcpiNsCompareNames (
|
|
char *Name1,
|
|
char *Name2);
|
|
|
|
void
|
|
AcpiNsRemoveReference (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
|
|
/*
|
|
* Namespace modification - nsmodify
|
|
*/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsUnloadNamespace (
|
|
ACPI_HANDLE Handle);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsDeleteSubtree (
|
|
ACPI_HANDLE StartHandle);
|
|
|
|
|
|
/*
|
|
* Namespace dump/print utilities - nsdump
|
|
*/
|
|
|
|
void
|
|
AcpiNsDumpTables (
|
|
ACPI_HANDLE SearchBase,
|
|
UINT32 MaxDepth);
|
|
|
|
void
|
|
AcpiNsDumpEntry (
|
|
ACPI_HANDLE Handle,
|
|
UINT32 DebugLevel);
|
|
|
|
void
|
|
AcpiNsDumpPathname (
|
|
ACPI_HANDLE Handle,
|
|
char *Msg,
|
|
UINT32 Level,
|
|
UINT32 Component);
|
|
|
|
void
|
|
AcpiNsPrintPathname (
|
|
UINT32 NumSegments,
|
|
char *Pathname);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsDumpOneDevice (
|
|
ACPI_HANDLE ObjHandle,
|
|
UINT32 Level,
|
|
void *Context,
|
|
void **ReturnValue);
|
|
|
|
void
|
|
AcpiNsDumpRootDevices (
|
|
void);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsDumpOneObject (
|
|
ACPI_HANDLE ObjHandle,
|
|
UINT32 Level,
|
|
void *Context,
|
|
void **ReturnValue);
|
|
|
|
void
|
|
AcpiNsDumpObjects (
|
|
ACPI_OBJECT_TYPE Type,
|
|
UINT8 DisplayType,
|
|
UINT32 MaxDepth,
|
|
UINT32 OwnderId,
|
|
ACPI_HANDLE StartHandle);
|
|
|
|
|
|
/*
|
|
* Namespace evaluation functions - nseval
|
|
*/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsEvaluateByHandle (
|
|
ACPI_NAMESPACE_NODE *PrefixNode,
|
|
ACPI_OPERAND_OBJECT **Params,
|
|
ACPI_OPERAND_OBJECT **ReturnObject);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsEvaluateByName (
|
|
char *Pathname,
|
|
ACPI_OPERAND_OBJECT **Params,
|
|
ACPI_OPERAND_OBJECT **ReturnObject);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsEvaluateRelative (
|
|
ACPI_NAMESPACE_NODE *PrefixNode,
|
|
char *Pathname,
|
|
ACPI_OPERAND_OBJECT **Params,
|
|
ACPI_OPERAND_OBJECT **ReturnObject);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsExecuteControlMethod (
|
|
ACPI_NAMESPACE_NODE *MethodNode,
|
|
ACPI_OPERAND_OBJECT **Params,
|
|
ACPI_OPERAND_OBJECT **ReturnObjDesc);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsGetObjectValue (
|
|
ACPI_NAMESPACE_NODE *ObjectNode,
|
|
ACPI_OPERAND_OBJECT **ReturnObjDesc);
|
|
|
|
|
|
/*
|
|
* Parent/Child/Peer utility functions
|
|
*/
|
|
|
|
ACPI_NAME
|
|
AcpiNsFindParentName (
|
|
ACPI_NAMESPACE_NODE *NodeToSearch);
|
|
|
|
|
|
/*
|
|
* Name and Scope manipulation - nsnames
|
|
*/
|
|
|
|
UINT32
|
|
AcpiNsOpensScope (
|
|
ACPI_OBJECT_TYPE Type);
|
|
|
|
void
|
|
AcpiNsBuildExternalPath (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_SIZE Size,
|
|
char *NameBuffer);
|
|
|
|
char *
|
|
AcpiNsGetExternalPathname (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
char *
|
|
AcpiNsNameOfCurrentScope (
|
|
ACPI_WALK_STATE *WalkState);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsHandleToPathname (
|
|
ACPI_HANDLE TargetHandle,
|
|
ACPI_BUFFER *Buffer);
|
|
|
|
BOOLEAN
|
|
AcpiNsPatternMatch (
|
|
ACPI_NAMESPACE_NODE *ObjNode,
|
|
char *SearchFor);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsGetNodeByPath (
|
|
char *ExternalPathname,
|
|
ACPI_NAMESPACE_NODE *InPrefixNode,
|
|
UINT32 Flags,
|
|
ACPI_NAMESPACE_NODE **OutNode);
|
|
|
|
ACPI_SIZE
|
|
AcpiNsGetPathnameLength (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
|
|
/*
|
|
* Object management for namespace nodes - nsobject
|
|
*/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsAttachObject (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OPERAND_OBJECT *Object,
|
|
ACPI_OBJECT_TYPE Type);
|
|
|
|
ACPI_OPERAND_OBJECT *
|
|
AcpiNsGetAttachedObject (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
ACPI_OPERAND_OBJECT *
|
|
AcpiNsGetSecondaryObject (
|
|
ACPI_OPERAND_OBJECT *ObjDesc);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsAttachData (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OBJECT_HANDLER Handler,
|
|
void *Data);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsDetachData (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OBJECT_HANDLER Handler);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsGetAttachedData (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OBJECT_HANDLER Handler,
|
|
void **Data);
|
|
|
|
|
|
/*
|
|
* Namespace searching and entry - nssearch
|
|
*/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsSearchAndEnter (
|
|
UINT32 EntryName,
|
|
ACPI_WALK_STATE *WalkState,
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_INTERPRETER_MODE InterpreterMode,
|
|
ACPI_OBJECT_TYPE Type,
|
|
UINT32 Flags,
|
|
ACPI_NAMESPACE_NODE **RetNode);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsSearchNode (
|
|
UINT32 EntryName,
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OBJECT_TYPE Type,
|
|
ACPI_NAMESPACE_NODE **RetNode);
|
|
|
|
void
|
|
AcpiNsInstallNode (
|
|
ACPI_WALK_STATE *WalkState,
|
|
ACPI_NAMESPACE_NODE *ParentNode,
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
ACPI_OBJECT_TYPE Type);
|
|
|
|
|
|
/*
|
|
* Utility functions - nsutils
|
|
*/
|
|
|
|
BOOLEAN
|
|
AcpiNsValidRootPrefix (
|
|
char Prefix);
|
|
|
|
BOOLEAN
|
|
AcpiNsValidPathSeparator (
|
|
char Sep);
|
|
|
|
ACPI_OBJECT_TYPE
|
|
AcpiNsGetType (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
UINT32
|
|
AcpiNsLocal (
|
|
ACPI_OBJECT_TYPE Type);
|
|
|
|
void
|
|
AcpiNsReportError (
|
|
char *ModuleName,
|
|
UINT32 LineNumber,
|
|
UINT32 ComponentId,
|
|
char *InternalName,
|
|
ACPI_STATUS LookupStatus);
|
|
|
|
void
|
|
AcpiNsReportMethodError (
|
|
char *ModuleName,
|
|
UINT32 LineNumber,
|
|
UINT32 ComponentId,
|
|
char *Message,
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
char *Path,
|
|
ACPI_STATUS LookupStatus);
|
|
|
|
void
|
|
AcpiNsPrintNodePathname (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
char *Msg);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsBuildInternalName (
|
|
ACPI_NAMESTRING_INFO *Info);
|
|
|
|
void
|
|
AcpiNsGetInternalNameLength (
|
|
ACPI_NAMESTRING_INFO *Info);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsInternalizeName (
|
|
char *DottedName,
|
|
char **ConvertedName);
|
|
|
|
ACPI_STATUS
|
|
AcpiNsExternalizeName (
|
|
UINT32 InternalNameLength,
|
|
char *InternalName,
|
|
UINT32 *ConvertedNameLength,
|
|
char **ConvertedName);
|
|
|
|
ACPI_NAMESPACE_NODE *
|
|
AcpiNsMapHandleToNode (
|
|
ACPI_HANDLE Handle);
|
|
|
|
ACPI_HANDLE
|
|
AcpiNsConvertEntryToHandle(
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
void
|
|
AcpiNsTerminate (
|
|
void);
|
|
|
|
ACPI_NAMESPACE_NODE *
|
|
AcpiNsGetParentNode (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
|
|
ACPI_NAMESPACE_NODE *
|
|
AcpiNsGetNextValidNode (
|
|
ACPI_NAMESPACE_NODE *Node);
|
|
|
|
|
|
#endif /* __ACNAMESP_H__ */
|