/****************************************************************************** * * Name: namesp.h - Namespace subcomponent prototypes and defines * *****************************************************************************/ /****************************************************************************** * * 1. Copyright Notice * * Some or all of this work - Copyright (c) 1999, 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 __NAMESPACE_H__ #define __NAMESPACE_H__ #include #include #include #include /* To search the entire name space, pass this as SearchBase */ #define NS_ALL ((ACPI_HANDLE)0) /* * Elements of NsProperties are bit significant * and should be one-to-one with values of ACPI_OBJECT_TYPE */ #define NSP_NORMAL 0 #define NSP_NEWSCOPE 1 /* a definition of this type opens a name scope */ #define NSP_LOCAL 2 /* suppress search of enclosing scopes */ /* Definitions of the predefined namespace names */ #define NS_ROOT "/ " #define NS_ROOT_PATH "/" #define NS_SYSTEM_BUS "_SB_" /* Flags for NsLookup, NsSearchAndEnter */ #define NS_NO_UPSEARCH 0 #define NS_SEARCH_PARENT 0x01 #define NS_DONT_OPEN_SCOPE 0x02 #define NS_NO_PEER_SEARCH 0x04 #define NS_WALK_UNLOCK TRUE #define NS_WALK_NO_UNLOCK FALSE ACPI_STATUS NsWalkNamespace ( ACPI_OBJECT_TYPE Type, ACPI_HANDLE StartObject, UINT32 MaxDepth, BOOLEAN UnlockBeforeCallback, WALK_CALLBACK UserFunction, void *Context, void **ReturnValue); NAME_TABLE_ENTRY * NsGetNextObject ( ACPI_OBJECT_TYPE Type, NAME_TABLE_ENTRY *Parent, NAME_TABLE_ENTRY *Child); ACPI_STATUS NsDeleteNamespaceByOwner ( UINT16 TableId); void NsFreeTableEntry ( NAME_TABLE_ENTRY *Entry); /* Namespace loading - nsload */ ACPI_STATUS NsParseTable ( ACPI_TABLE_DESC *TableDesc, NAME_TABLE_ENTRY *Scope); ACPI_STATUS NsLoadTable ( ACPI_TABLE_DESC *TableDesc, NAME_TABLE_ENTRY *Entry); ACPI_STATUS NsLoadTableByType ( ACPI_TABLE_TYPE TableType); /* * Top-level namespace access - nsaccess */ ACPI_STATUS NsRootInitialize ( void); ACPI_STATUS NsLookup ( SCOPE_STACK *ScopeInfo, char *Name, ACPI_OBJECT_TYPE Type, OPERATING_MODE InterpreterMode, UINT32 Flags, ACPI_WALK_STATE *WalkState, NAME_TABLE_ENTRY **RetEntry); /* * Table allocation/deallocation - nsalloc */ NAME_TABLE_ENTRY * NsAllocateNameTable ( INT32 NteEntries); ACPI_STATUS NsDeleteNamespaceSubtree ( NAME_TABLE_ENTRY *ParentHandle); void NsDetachObject ( ACPI_HANDLE Object); void NsDeleteScope ( ACPI_HANDLE Scope); /* * Namespace modification - nsmodify */ ACPI_STATUS NsUnloadNamespace ( ACPI_HANDLE Handle); ACPI_STATUS NsDeleteSubtree ( ACPI_HANDLE StartHandle); /* * Namespace dump/print utilities - nsdump */ void NsDumpTables ( ACPI_HANDLE SearchBase, INT32 MaxDepth); void NsDumpEntry ( ACPI_HANDLE Handle, UINT32 DebugLevel); ACPI_STATUS NsDumpPathname ( ACPI_HANDLE Handle, char *Msg, UINT32 Level, UINT32 Component); void NsDumpRootDevices ( void); void NsDumpObjects ( ACPI_OBJECT_TYPE Type, UINT32 MaxDepth, UINT32 OwnderId, ACPI_HANDLE StartHandle); /* * Namespace evaluation functions - nseval */ ACPI_STATUS NsEvaluateByHandle ( NAME_TABLE_ENTRY *ObjectNte, ACPI_OBJECT_INTERNAL **Params, ACPI_OBJECT_INTERNAL **ReturnObject); ACPI_STATUS NsEvaluateByName ( char *Pathname, ACPI_OBJECT_INTERNAL **Params, ACPI_OBJECT_INTERNAL **ReturnObject); ACPI_STATUS NsEvaluateRelative ( NAME_TABLE_ENTRY *ObjectNte, char *Pathname, ACPI_OBJECT_INTERNAL **Params, ACPI_OBJECT_INTERNAL **ReturnObject); ACPI_STATUS NsExecuteControlMethod ( NAME_TABLE_ENTRY *MethodEntry, ACPI_OBJECT_INTERNAL **Params, ACPI_OBJECT_INTERNAL **ReturnObjDesc); ACPI_STATUS NsGetObjectValue ( NAME_TABLE_ENTRY *ObjectEntry, ACPI_OBJECT_INTERNAL **ReturnObjDesc); /* * Parent/Child/Peer utility functions - nsfamily */ ACPI_NAME NsFindParentName ( NAME_TABLE_ENTRY *EntryToSearch); INT32 NsExistDownstreamSibling ( NAME_TABLE_ENTRY *ThisEntry, INT32 Size, NAME_TABLE_ENTRY *Appendage); /* * Scope manipulation - nsscope */ INT32 NsOpensScope ( ACPI_OBJECT_TYPE Type); char * NsNameOfScope ( NAME_TABLE_ENTRY *EntryToSearch); char * NsNameOfCurrentScope ( ACPI_WALK_STATE *WalkState); ACPI_STATUS NsHandleToPathname ( ACPI_HANDLE ObjHandle, UINT32 *BufSize, char *UserBuffer); BOOLEAN NsPatternMatch ( NAME_TABLE_ENTRY *ObjEntry, char *SearchFor); ACPI_STATUS NsNameCompare ( ACPI_HANDLE ObjHandle, UINT32 Level, void *Context, void **ReturnValue); void NsLowFindNames ( NAME_TABLE_ENTRY *ThisEntry, char *SearchFor, INT32 *Count, ACPI_HANDLE List[], INT32 MaxDepth); ACPI_HANDLE * NsFindNames ( char *SearchFor, ACPI_HANDLE SearchBase, INT32 MaxDepth); ACPI_STATUS NsGetNte ( char *Name, ACPI_HANDLE Scope, NAME_TABLE_ENTRY **OutNte); /* * Object management for NTEs - nsobject */ ACPI_STATUS NsAttachMethod ( ACPI_HANDLE ObjHandle, UINT8 *PcodeAddr, UINT32 PcodeLength); ACPI_STATUS NsAttachObject ( ACPI_HANDLE ObjHandle, ACPI_HANDLE Value, UINT8 ValTyp); void * NsCompareValue ( ACPI_HANDLE ObjHandle, UINT32 Level, void *ObjDesc); ACPI_HANDLE NsFindAttachedObject ( ACPI_OBJECT_INTERNAL *ObjDesc, ACPI_HANDLE SearchBase, INT32 MaxDepth); /* * Namespace searching and entry - nssearch */ ACPI_STATUS NsSearchAndEnter ( UINT32 EntryName, ACPI_WALK_STATE *WalkState, NAME_TABLE_ENTRY *NameTable, OPERATING_MODE InterpreterMode, ACPI_OBJECT_TYPE Type, UINT32 Flags, NAME_TABLE_ENTRY **RetEntry); void NsInitializeTable ( NAME_TABLE_ENTRY *NewTbl, NAME_TABLE_ENTRY *ParentScope, NAME_TABLE_ENTRY *ParentEntry); ACPI_STATUS NsSearchOneScope ( UINT32 EntryName, NAME_TABLE_ENTRY *NameTable, ACPI_OBJECT_TYPE Type, NAME_TABLE_ENTRY **RetEntry, NS_SEARCH_DATA *RetInfo); /* * Utility functions - nsutils */ BOOLEAN NsValidRootPrefix ( char Prefix); BOOLEAN NsValidPathSeparator ( char Sep); ACPI_OBJECT_TYPE NsGetType ( ACPI_HANDLE ObjHandle); void * NsGetAttachedObject ( ACPI_HANDLE ObjHandle); INT32 NsLocal ( ACPI_OBJECT_TYPE Type); ACPI_STATUS NsInternalizeName ( char *DottedName, char **ConvertedName); ACPI_STATUS NsExternalizeName ( UINT32 InternalNameLength, char *InternalName, UINT32 *ConvertedNameLength, char **ConvertedName); INT32 IsNsObject ( ACPI_OBJECT_INTERNAL *pOD); INT32 NsMarkNS( void); NAME_TABLE_ENTRY * NsConvertHandleToEntry ( ACPI_HANDLE Handle); ACPI_HANDLE NsConvertEntryToHandle( NAME_TABLE_ENTRY *Nte); void NsTerminate ( void); #endif /* __NAMESPACE_H__ */