AmlCoreInterface.h

Go to the documentation of this file.

 
#ifndef AML_CORE_INTERFACE_H_
#define AML_CORE_INTERFACE_H_
 
/* This header file does not include internal Node definition,
   i.e. AML_ROOT_NODE, AML_OBJECT_NODE, etc. The node definitions
   must be included by the caller file. The function prototypes must
   only expose AML_NODE_HANDLE, AML_ROOT_NODE_HANDLE, etc. node
   definitions.
   This allows to keep the functions defined here both internal and
   potentially external. If necessary, any function of this file can
   be exposed externally.
   The Api folder is internal to the AmlLib, but should only use these
   functions. They provide a "safe" way to interact with the AmlLib.
*/
 
#include <AmlDefines.h>
#include <Include/Library/AmlLib/AmlLib.h>
#include <ResourceData/AmlResourceData.h>
 
EFI_STATUS
EFIAPI
AmlSerializeTree (
  IN      AML_ROOT_NODE_HANDLE  RootNode,
  IN      UINT8                 *Buffer      OPTIONAL,
  IN  OUT UINT32                *BufferSize
  );
 
EFI_STATUS
EFIAPI
AmlCloneNode (
  IN  AML_NODE_HANDLE  Node,
  OUT AML_NODE_HANDLE  *ClonedNode
  );
 
EFI_STATUS
EFIAPI
AmlRemoveNodeFromVarArgList (
  IN  AML_NODE_HANDLE  Node
  );
 
EFI_STATUS
EFIAPI
AmlVarListAddHead (
  IN  AML_NODE_HANDLE  ParentNode,
  IN  AML_NODE_HANDLE  NewNode
  );
 
EFI_STATUS
EFIAPI
AmlVarListAddTail (
  IN  AML_NODE_HANDLE  ParentNode,
  IN  AML_NODE_HANDLE  NewNode
  );
 
EFI_STATUS
EFIAPI
AmlVarListAddBefore (
  IN  AML_NODE_HANDLE  Node,
  IN  AML_NODE_HANDLE  NewNode
  );
 
EFI_STATUS
EFIAPI
AmlVarListAddAfter (
  IN  AML_NODE_HANDLE  Node,
  IN  AML_NODE_HANDLE  NewNode
  );
 
EFI_STATUS
EFIAPI
AmlAppendRdNode (
  IN  AML_OBJECT_NODE_HANDLE  BufferOpNode,
  IN  AML_DATA_NODE_HANDLE    NewRdNode
  );
 
EFI_STATUS
EFIAPI
AmlReplaceVariableArgument (
  IN  AML_NODE_HANDLE  OldNode,
  IN  AML_NODE_HANDLE  NewNode
  );
 
EAML_NODE_TYPE
EFIAPI
AmlGetNodeType (
  IN  AML_NODE_HANDLE  Node
  );
 
EFI_STATUS
EFIAPI
AmlGetRootNodeInfo (
  IN  AML_ROOT_NODE_HANDLE         RootNode,
  OUT EFI_ACPI_DESCRIPTION_HEADER  *SdtHeaderBuffer
  );
 
EFI_STATUS
EFIAPI
AmlGetObjectNodeInfo (
  IN  AML_OBJECT_NODE_HANDLE  ObjectNode,
  OUT UINT8                   *OpCode            OPTIONAL,
  OUT UINT8                   *SubOpCode         OPTIONAL,
  OUT UINT32                  *PkgLen            OPTIONAL,
  OUT BOOLEAN                 *IsNameSpaceNode   OPTIONAL
  );
 
UINT8
AmlGetFixedArgumentCount (
  IN  AML_OBJECT_NODE_HANDLE  Node
  );
 
EFI_STATUS
EFIAPI
AmlGetNodeDataType (
  IN  AML_DATA_NODE_HANDLE  DataNode,
  OUT EAML_NODE_DATA_TYPE   *DataType
  );
 
EFI_STATUS
EFIAPI
AmlGetResourceDataType (
  IN  AML_DATA_NODE_HANDLE  DataNode,
  OUT AML_RD_HEADER         *ResourceDataType
  );
 
EFI_STATUS
EFIAPI
AmlGetDataNodeBuffer (
  IN      AML_DATA_NODE_HANDLE  DataNode,
  OUT UINT8                     *Buffer      OPTIONAL,
  IN  OUT UINT32                *BufferSize
  );
 
EFI_STATUS
EFIAPI
AmlUpdateRootNode (
  IN        AML_ROOT_NODE_HANDLE         RootNode,
  IN  CONST EFI_ACPI_DESCRIPTION_HEADER  *SdtHeader
  );
 
EFI_STATUS
EFIAPI
AmlUpdateInteger (
  IN  AML_OBJECT_NODE_HANDLE  IntegerOpNode,
  IN  UINT64                  NewInteger
  );
 
EFI_STATUS
EFIAPI
AmlUpdateDataNode (
  IN  AML_DATA_NODE_HANDLE  DataNode,
  IN  EAML_NODE_DATA_TYPE   DataType,
  IN  UINT8                 *Buffer,
  IN  UINT32                Size
  );
 
AML_NODE_HANDLE
EFIAPI
AmlGetParent (
  IN  AML_NODE_HANDLE  Node
  );
 
AML_NODE_HANDLE
EFIAPI
AmlGetFixedArgument (
  IN  AML_OBJECT_NODE_HANDLE  ObjectNode,
  IN  EAML_PARSE_INDEX        Index
  );
 
AML_NODE_HANDLE
EFIAPI
AmlGetSiblingVariableArgument (
  IN  AML_NODE_HANDLE  VarArgNode
  );
 
AML_NODE_HANDLE
EFIAPI
AmlGetNextVariableArgument (
  IN  AML_NODE_HANDLE  Node,
  IN  AML_NODE_HANDLE  CurrVarArg
  );
 
AML_NODE_HANDLE
EFIAPI
AmlGetPreviousVariableArgument (
  IN  AML_NODE_HANDLE  Node,
  IN  AML_NODE_HANDLE  CurrVarArg
  );
 
typedef
BOOLEAN
(EFIAPI *EDKII_AML_TREE_ENUM_CALLBACK)(
  IN       AML_NODE_HANDLE     Node,
  IN  OUT  VOID              *Context     OPTIONAL,
  IN  OUT  EFI_STATUS        *Status      OPTIONAL
  );
 
BOOLEAN
EFIAPI
AmlEnumTree (
  IN      AML_NODE_HANDLE               Node,
  IN      EDKII_AML_TREE_ENUM_CALLBACK  CallBack,
  IN  OUT VOID                          *Context   OPTIONAL,
  OUT EFI_STATUS                        *Status    OPTIONAL
  );
 
EFI_STATUS
EFIAPI
AmlGetAslPathName (
  IN      AML_NODE_HANDLE  Node,
  OUT CHAR8                *Buffer,
  IN  OUT UINT32           *BufferSize
  );
 
#endif // AML_CORE_INTERFACE_H_