AmlDbgPrint.h

Go to the documentation of this file.

 
#ifndef AML_PRINT_H_
#define AML_PRINT_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.
*/
 
#if !defined (MDEPKG_NDEBUG)
 
  #include <AmlInclude.h>
 
VOID
EFIAPI
AmlDbgDumpRaw (
  IN  CONST UINT8   *Ptr,
  IN        UINT32  Length
  );
 
VOID
EFIAPI
AmlDbgPrintChars (
  IN        UINT32  ErrorLevel,
  IN  CONST CHAR8   *Buffer,
  IN        UINT32  Size
  );
 
VOID
EFIAPI
AmlDbgPrintNameSeg (
  IN  CONST CHAR8  *Buffer
  );
 
VOID
EFIAPI
AmlDbgPrintNameString (
  IN  CONST CHAR8    *Buffer,
  IN        BOOLEAN  NewLine
  );
 
VOID
EFIAPI
AmlDbgPrintNode (
  IN  AML_NODE_HANDLE  Node
  );
 
VOID
EFIAPI
AmlDbgPrintTree (
  IN  AML_NODE_HANDLE  Node
  );
 
EFI_STATUS
EFIAPI
AmlDbgPrintNameSpace (
  IN  AML_ROOT_NODE_HANDLE  RootNode
  );
 
/* Macros to encapsulate Aml Debug Print APIs.
*/
 
#define AMLDBG_DUMP_RAW(Ptr, Length)                  \
          AmlDbgDumpRaw (Ptr, Length)
 
#define AMLDBG_PRINT_CHARS(ErrorLevel, Buffer, Size)  \
          AmlDbgPrintChars (ErrorLevel, Buffer, Size)
 
#define AMLDBG_PRINT_NAMESEG(Buffer)                  \
          AmlDbgPrintNameSeg (Buffer)
 
#define AMLDBG_PRINT_NAMESTR(Buffer, NewLine)          \
          AmlDbgPrintNameString (Buffer,NewLine)
 
#define AMLDBG_PRINT_NODE(Node)                       \
          AmlDbgPrintNode (Node)
 
#define AMLDBG_PRINT_TREE(Node)                       \
          AmlDbgPrintTree (Node)
 
#define AMLDBG_PRINT_NAMESPACE(RootNode)              \
          AmlDbgPrintNameSpace (RootNode)
 
#else
 
#define AMLDBG_DUMP_RAW(Ptr, Length)
 
#define AMLDBG_PRINT_CHARS(ErrorLevel, Buffer, Size)
 
#define AMLDBG_PRINT_NAMESEG(Buffer)
 
#define AMLDBG_PRINT_NAMESTR(Buffer, NewLine)
 
#define AMLDBG_PRINT_NODE(Node)
 
#define AMLDBG_PRINT_TREE(Node)
 
#define AMLDBG_PRINT_NAMESPACE(RootNode)
 
#endif // MDEPKG_NDEBUG
 
#endif // AML_PRINT_H_