Subversion Repositories Kolibri OS

/******************************************************************************

 *

 * Name: acnamesp.h - Namespace subcomponent prototypes and defines

 *

 *****************************************************************************/

/******************************************************************************

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, 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 */

/* 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_PREFIX_IS_SCOPE     0x10

#define ACPI_NS_EXTERNAL            0x20

#define ACPI_NS_TEMPORARY           0x40

/* Flags for AcpiNsWalkNamespace */

#define ACPI_NS_WALK_NO_UNLOCK      0

#define ACPI_NS_WALK_UNLOCK         0x01

#define ACPI_NS_WALK_TEMP_NODES     0x02

/* Object is not a package element */

#define ACPI_NOT_PACKAGE_ELEMENT    ACPI_UINT32_MAX

/* Always emit warning message, not dependent on node flags */

#define ACPI_WARN_ALWAYS            0

/*

 * nsinit - Namespace initialization

 */

ACPI_STATUS

AcpiNsInitializeObjects (

    void);

ACPI_STATUS

AcpiNsInitializeDevices (

    void);

/*

 * nsload -  Namespace loading

 */

ACPI_STATUS

AcpiNsLoadNamespace (

    void);

ACPI_STATUS

AcpiNsLoadTable (

    UINT32                  TableIndex,

    ACPI_NAMESPACE_NODE     *Node);

/*

 * nswalk - walk the namespace

 */

ACPI_STATUS

AcpiNsWalkNamespace (

    ACPI_OBJECT_TYPE        Type,

    ACPI_HANDLE             StartObject,

    UINT32                  MaxDepth,

    UINT32                  Flags,

    ACPI_WALK_CALLBACK      PreOrderVisit,

    ACPI_WALK_CALLBACK      PostOrderVisit,

    void                    *Context,

    void                    **ReturnValue);

ACPI_NAMESPACE_NODE *

AcpiNsGetNextNode (

    ACPI_NAMESPACE_NODE     *Parent,

    ACPI_NAMESPACE_NODE     *Child);

ACPI_NAMESPACE_NODE *

AcpiNsGetNextNodeTyped (

    ACPI_OBJECT_TYPE        Type,

    ACPI_NAMESPACE_NODE     *Parent,

    ACPI_NAMESPACE_NODE     *Child);

/*

 * nsparse - table parsing

 */

ACPI_STATUS

AcpiNsParseTable (

    UINT32                  TableIndex,

    ACPI_NAMESPACE_NODE     *StartNode);

ACPI_STATUS

AcpiNsOneCompleteParse (

    UINT32                  PassNumber,

    UINT32                  TableIndex,

    ACPI_NAMESPACE_NODE     *StartNode);

/*

 * nsaccess - Top-level namespace access

 */

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);

/*

 * nsalloc - Named object allocation/deallocation

 */

ACPI_NAMESPACE_NODE *

AcpiNsCreateNode (

    UINT32                  Name);

void

AcpiNsDeleteNode (

    ACPI_NAMESPACE_NODE     *Node);

void

AcpiNsRemoveNode (

    ACPI_NAMESPACE_NODE     *Node);

void

AcpiNsDeleteNamespaceSubtree (

    ACPI_NAMESPACE_NODE     *ParentHandle);

void

AcpiNsDeleteNamespaceByOwner (

    ACPI_OWNER_ID           OwnerId);

void

AcpiNsDetachObject (

    ACPI_NAMESPACE_NODE     *Node);

void

AcpiNsDeleteChildren (

    ACPI_NAMESPACE_NODE     *Parent);

int

AcpiNsCompareNames (

    char                    *Name1,

    char                    *Name2);

/*

 * nsdump - Namespace dump/print utilities

 */

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

AcpiNsDumpOneObject (

    ACPI_HANDLE             ObjHandle,

    UINT32                  Level,

    void                    *Context,

    void                    **ReturnValue);

void

AcpiNsDumpObjects (

    ACPI_OBJECT_TYPE        Type,

    UINT8                   DisplayType,

    UINT32                  MaxDepth,

    ACPI_OWNER_ID           OwnerId,

    ACPI_HANDLE             StartHandle);

/*

 * nseval - Namespace evaluation functions

 */

ACPI_STATUS

AcpiNsEvaluate (

    ACPI_EVALUATE_INFO      *Info);

void

AcpiNsExecModuleCodeList (

    void);

/*

 * nspredef - Support for predefined/reserved names

 */

ACPI_STATUS

AcpiNsCheckPredefinedNames (

    ACPI_NAMESPACE_NODE     *Node,

    UINT32                  UserParamCount,

    ACPI_STATUS             ReturnStatus,

    ACPI_OPERAND_OBJECT     **ReturnObject);

const ACPI_PREDEFINED_INFO *

AcpiNsCheckForPredefinedName (

    ACPI_NAMESPACE_NODE     *Node);

void

AcpiNsCheckParameterCount (

    char                        *Pathname,

    ACPI_NAMESPACE_NODE         *Node,

    UINT32                      UserParamCount,

    const ACPI_PREDEFINED_INFO  *Info);

/*

 * nsnames - Name and Scope manipulation

 */

UINT32

AcpiNsOpensScope (

    ACPI_OBJECT_TYPE        Type);

ACPI_STATUS

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

AcpiNsGetNode (

    ACPI_NAMESPACE_NODE     *PrefixNode,

    const char              *ExternalPathname,

    UINT32                  Flags,

    ACPI_NAMESPACE_NODE     **OutNode);

ACPI_SIZE

AcpiNsGetPathnameLength (

    ACPI_NAMESPACE_NODE     *Node);

/*

 * nsobject - Object management for namespace nodes

 */

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);

/*

 * nsrepair - General return object repair for all

 * predefined methods/objects

 */

ACPI_STATUS

AcpiNsRepairObject (

    ACPI_PREDEFINED_DATA    *Data,

    UINT32                  ExpectedBtypes,

    UINT32                  PackageIndex,

    ACPI_OPERAND_OBJECT     **ReturnObjectPtr);

ACPI_STATUS

AcpiNsRepairPackageList (

    ACPI_PREDEFINED_DATA    *Data,

    ACPI_OPERAND_OBJECT     **ObjDescPtr);

ACPI_STATUS

AcpiNsRepairNullElement (

    ACPI_PREDEFINED_DATA    *Data,

    UINT32                  ExpectedBtypes,

    UINT32                  PackageIndex,

    ACPI_OPERAND_OBJECT     **ReturnObjectPtr);

void

AcpiNsRemoveNullElements (

    ACPI_PREDEFINED_DATA    *Data,

    UINT8                   PackageType,

    ACPI_OPERAND_OBJECT     *ObjDesc);

/*

 * nsrepair2 - Return object repair for specific

 * predefined methods/objects

 */

ACPI_STATUS

AcpiNsComplexRepairs (

    ACPI_PREDEFINED_DATA    *Data,

    ACPI_NAMESPACE_NODE     *Node,

    ACPI_STATUS             ValidateStatus,

    ACPI_OPERAND_OBJECT     **ReturnObjectPtr);

/*

 * nssearch - Namespace searching and entry

 */

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

AcpiNsSearchOneScope (

    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);

/*

 * nsutils - Utility functions

 */

BOOLEAN

AcpiNsValidRootPrefix (

    char                    Prefix);

ACPI_OBJECT_TYPE

AcpiNsGetType (

    ACPI_NAMESPACE_NODE     *Node);

UINT32

AcpiNsLocal (

    ACPI_OBJECT_TYPE        Type);

void

AcpiNsPrintNodePathname (

    ACPI_NAMESPACE_NODE     *Node,

    const char              *Msg);

ACPI_STATUS

AcpiNsBuildInternalName (

    ACPI_NAMESTRING_INFO    *Info);

void

AcpiNsGetInternalNameLength (

    ACPI_NAMESTRING_INFO    *Info);

ACPI_STATUS

AcpiNsInternalizeName (

    const char              *DottedName,

    char                    **ConvertedName);

ACPI_STATUS

AcpiNsExternalizeName (

    UINT32                  InternalNameLength,

    const char              *InternalName,

    UINT32                  *ConvertedNameLength,

    char                    **ConvertedName);

ACPI_NAMESPACE_NODE *

AcpiNsValidateHandle (

    ACPI_HANDLE             Handle);

void

AcpiNsTerminate (

    void);

#endif /* __ACNAMESP_H__ */