AmlTreeIterator.h

Go to the documentation of this file.

 
#ifndef AML_ITERATOR_H_
#define AML_ITERATOR_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.
*/
 
typedef enum EAmlIteratorMode {
  EAmlIteratorUnknown,        
  EAmlIteratorLinear,         
  EAmlIteratorBranch,         
  EAmlIteratorModeMax         
} EAML_ITERATOR_MODE;
 
typedef struct AmlTreeIterator AML_TREE_ITERATOR;
 
typedef
EFI_STATUS
(EFIAPI *EDKII_AML_TREE_ITERATOR_GET_NODE)(
  IN  AML_TREE_ITERATOR  *Iterator,
  OUT AML_NODE_HANDLE    *OutNode
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_AML_TREE_ITERATOR_GET_NEXT)(
  IN  AML_TREE_ITERATOR  *Iterator,
  OUT AML_NODE_HANDLE    *NextNode
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_AML_TREE_ITERATOR_GET_PREVIOUS)(
  IN  AML_TREE_ITERATOR  *Iterator,
  OUT AML_NODE_HANDLE    *PrevNode
  );
 
typedef struct AmlTreeIterator {
  EDKII_AML_TREE_ITERATOR_GET_NODE        GetNode;
 
  EDKII_AML_TREE_ITERATOR_GET_NEXT        GetNext;
 
  EDKII_AML_TREE_ITERATOR_GET_PREVIOUS    GetPrevious;
} AML_TREE_ITERATOR;
 
EFI_STATUS
EFIAPI
AmlInitializeIterator (
  IN   AML_NODE_HANDLE     Node,
  IN   EAML_ITERATOR_MODE  IteratorMode,
  OUT  AML_TREE_ITERATOR   **IteratorPtr
  );
 
EFI_STATUS
EFIAPI
AmlDeleteIterator (
  IN  AML_TREE_ITERATOR  *Iterator
  );
 
#endif // AML_ITERATOR_H_