[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / EdkIIGlueLib / Include / Library / EdkIIGlueDebugLib.h

/*++\r
\r
Copyright (c) 2004 - 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  \r
\r
\r
Module Name:\r
\r
  EdkIIGlueDebugLib.h\r
  \r
Abstract: \r
\r
  Public include file for the Debug Library\r
\r
--*/\r
\r
#ifndef __EDKII_GLUE_DEBUG_LIB_H__\r
#define __EDKII_GLUE_DEBUG_LIB_H__\r
\r
//\r
// To use EdkII code, these R8.x macros are undefined\r
//\r
#undef ASSERT\r
#undef DEBUG\r
#undef ASSERT_EFI_ERROR\r
#undef ASSERT_PROTOCOL_ALREADY_INSTALLED\r
#undef DEBUG_CODE\r
#undef CR\r
\r
#undef EFI_D_INIT\r
#undef EFI_D_WARN\r
#undef EFI_D_LOAD\r
#undef EFI_D_FS\r
#undef EFI_D_POOL\r
#undef EFI_D_PAGE\r
#undef EFI_D_INFO\r
#undef EFI_D_VARIABLE\r
#undef EFI_D_BM   \r
#undef EFI_D_BLKIO\r
#undef EFI_D_NET    \r
#undef EFI_D_UNDI\r
#undef EFI_D_LOADFILE\r
#undef EFI_D_EVENT\r
#undef EFI_D_ERROR\r
\r
//\r
// Declare bits for PcdDebugPropertyMask\r
//\r
#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED       0x01\r
#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED        0x02\r
#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED         0x04\r
#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED       0x08\r
#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED  0x10\r
#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED    0x20\r
\r
//\r
// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()\r
//\r
#define DEBUG_INIT      0x00000001  // Initialization\r
#define DEBUG_WARN      0x00000002  // Warnings\r
#define DEBUG_LOAD      0x00000004  // Load events\r
#define DEBUG_FS        0x00000008  // EFI File system\r
#define DEBUG_POOL      0x00000010  // Alloc & Free's\r
#define DEBUG_PAGE      0x00000020  // Alloc & Free's\r
#define DEBUG_INFO      0x00000040  // Verbose\r
#define DEBUG_VARIABLE  0x00000100  // Variable\r
#define DEBUG_BM        0x00000400  // Boot Manager\r
#define DEBUG_BLKIO     0x00001000  // BlkIo Driver\r
#define DEBUG_NET       0x00004000  // SNI Driver\r
#define DEBUG_UNDI      0x00010000  // UNDI Driver\r
#define DEBUG_LOADFILE  0x00020000  // UNDI Driver\r
#define DEBUG_EVENT     0x00080000  // Event messages\r
#define DEBUG_ERROR     0x80000000  // Error\r
\r
//\r
// Aliases of debug message mask bits\r
//\r
#define EFI_D_INIT      DEBUG_INIT\r
#define EFI_D_WARN      DEBUG_WARN\r
#define EFI_D_LOAD      DEBUG_LOAD\r
#define EFI_D_FS        DEBUG_FS\r
#define EFI_D_POOL      DEBUG_POOL\r
#define EFI_D_PAGE      DEBUG_PAGE\r
#define EFI_D_INFO      DEBUG_INFO\r
#define EFI_D_VARIABLE  DEBUG_VARIABLE\r
#define EFI_D_BM        DEBUG_BM\r
#define EFI_D_BLKIO     DEBUG_BLKIO\r
#define EFI_D_NET       DEBUG_NET\r
#define EFI_D_UNDI      DEBUG_UNDI\r
#define EFI_D_LOADFILE  DEBUG_LOADFILE\r
#define EFI_D_EVENT     DEBUG_EVENT\r
#define EFI_D_ERROR     DEBUG_ERROR\r
\r
\r
//\r
// Use the following 4 macros to save size\r
//\r
#define DebugAssertEnabled()      ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0))\r
\r
#define DebugPrintEnabled()       ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0))\r
\r
#define DebugCodeEnabled()        ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0))\r
\r
#define DebugClearMemoryEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0))\r
\r
\r
/**\r
\r
  Prints a debug message to the debug output device if the specified error level is enabled.\r
\r
  If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
  the message specified by Format and the associated variable argument list to \r
  the debug output device.\r
\r
  If Format is NULL, then ASSERT().\r
\r
  @param  ErrorLevel  The error level of the debug message.\r
  @param  Format      Format string for the debug message to print.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugPrint (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  );\r
\r
\r
/**\r
\r
  Prints an assert message containing a filename, line number, and description.  \r
  This may be followed by a breakpoint or a dead loop.\r
\r
  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
  CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
  returns immediately after the message is printed to the debug output device.\r
  DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while\r
  processing another DebugAssert(), then DebugAssert() must return immediately.\r
\r
  If FileName is NULL, then a <FileName> string of ?NULL) Filename?is printed.\r
\r
  If Description is NULL, then a <Description> string of ?NULL) Description?is printed.\r
\r
  @param  FileName     Pointer to the name of the source file that generated the assert condition.\r
  @param  LineNumber   The line number in the source file that generated the assert condition\r
  @param  Description  Pointer to the description of the assert condition.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugAssert (\r
  IN CONST CHAR8  *FileName,\r
  IN UINTN        LineNumber,\r
  IN CONST CHAR8  *Description\r
  );\r
\r
\r
/**\r
\r
  Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
\r
  This function fills Length bytes of Buffer with the value specified by \r
  PcdDebugClearMemoryValue, and returns Buffer.\r
\r
  If Buffer is NULL, then ASSERT().\r
\r
  If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT(). \r
\r
  @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
  @return  Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
DebugClearMemory (\r
  OUT VOID  *Buffer,\r
  IN UINTN  Length\r
  );\r
\r
\r
/**\r
  \r
  Internal worker macro that calls DebugAssert().\r
\r
  This macro calls DebugAssert() passing in the filename, line number, and \r
  expression that evailated to FALSE.\r
\r
  @param  Expression  Boolean expression that evailated to FALSE\r
\r
**/\r
#ifdef EFI_DEBUG\r
#define _ASSERT(Expression)  DebugAssert (__FILE__, __LINE__, #Expression)\r
#else\r
#define _ASSERT(Expression)\r
\r
#endif\r
\r
/**\r
  \r
  Internal worker macro that calls DebugPrint().\r
\r
  This macro calls DebugPrint() passing in the debug error level, a format \r
  string, and a variable argument list.\r
\r
  @param  Expression  Expression containing an error level, a format string, \r
                      and a variable argument list based on the format string.\r
\r
**/\r
#ifdef EFI_DEBUG\r
#define _DEBUG(Expression)   DebugPrint Expression\r
#else\r
#define _DEBUG(Expression)\r
\r
#endif\r
\r
/**\r
  \r
  Macro that calls DebugAssert() if a expression evaluates to FALSE.\r
\r
  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro evaluates the Boolean expression specified by Expression.  If \r
  Expression evaluates to FALSE, then DebugAssert() is called passing in the \r
  source filename, source line number, and Expression.\r
\r
  @param  Expression  Boolean expression\r
\r
**/\r
#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
  // Glue Library internal\r
  \r
  #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
    #ifdef EFI_DEBUG\r
    #define ASSERT(Expression)        \\r
      do {                            \\r
        if (DebugAssertEnabled ()) {  \\r
          if (!(Expression)) {        \\r
            _ASSERT (Expression);     \\r
          }                           \\r
        }                             \\r
      } while (FALSE)\r
    #endif\r
  #else\r
    #define ASSERT(Expression) do{} while(0)\r
  #endif    \r
\r
#else\r
  // External usage\r
\r
  #ifdef EFI_DEBUG\r
    #define ASSERT(Expression)        \\r
      do {                            \\r
        if (DebugAssertEnabled ()) {  \\r
          if (!(Expression)) {        \\r
            _ASSERT (Expression);     \\r
          }                           \\r
        }                             \\r
      } while (FALSE)\r
  #else\r
    #define ASSERT(Expression) do{} while(0)\r
  #endif\r
\r
#endif\r
\r
/**\r
  \r
  Macro that calls DebugPrint().\r
\r
  If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro passes Expression to DebugPrint().\r
\r
  @param  Expression  Expression containing an error level, a format string, \r
                      and a variable argument list based on the format string.\r
  \r
\r
**/\r
#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
  // Glue Library internal\r
  \r
  #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
    #ifdef EFI_DEBUG\r
    #define DEBUG(Expression)        \\r
      do {                           \\r
        if (DebugPrintEnabled ()) {  \\r
          _DEBUG (Expression);       \\r
        }                            \\r
      } while (FALSE)\r
    #endif\r
  #else\r
    #define DEBUG(Expression) do{} while(0)\r
  #endif    \r
\r
#else\r
  // External usage\r
\r
  #ifdef EFI_DEBUG\r
    #define DEBUG(Expression)        \\r
      do {                           \\r
        if (DebugPrintEnabled ()) {  \\r
          _DEBUG (Expression);       \\r
        }                            \\r
      } while (FALSE)\r
  #else\r
    #define DEBUG(Expression) do{} while(0)\r
  #endif\r
\r
#endif\r
\r
\r
/**\r
  \r
  Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.\r
\r
  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro evaluates the EFI_STATUS value specified by StatusParameter.  \r
  If StatusParameter is an error code, then DebugAssert() is called passing in \r
  the source filename, source line number, and StatusParameter.\r
\r
  @param  StatusParameter  EFI_STATUS value to evaluate.\r
\r
**/\r
#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
  // Glue Library internal\r
  \r
  #if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
    #ifdef EFI_DEBUG\r
    #define ASSERT_EFI_ERROR(StatusParameter)                                              \\r
      do {                                                                                 \\r
        if (DebugAssertEnabled ()) {                                                       \\r
          if (EFI_ERROR (StatusParameter)) {                                               \\r
            DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter));  \\r
            _ASSERT (!EFI_ERROR (StatusParameter));                                        \\r
          }                                                                                \\r
        }                                                                                  \\r
      } while (FALSE)\r
    #endif\r
  #else\r
    #define ASSERT_EFI_ERROR(Expression) do{} while(0)\r
  #endif    \r
\r
#else\r
  // External usage\r
\r
  #ifdef EFI_DEBUG\r
    #define ASSERT_EFI_ERROR(StatusParameter)                                              \\r
      do {                                                                                 \\r
        if (DebugAssertEnabled ()) {                                                       \\r
          if (EFI_ERROR (StatusParameter)) {                                               \\r
            DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter));  \\r
            _ASSERT (!EFI_ERROR (StatusParameter));                                        \\r
          }                                                                                \\r
        }                                                                                  \\r
      } while (FALSE)\r
  #else\r
    #define ASSERT_EFI_ERROR(Expression) do{} while(0)\r
  #endif\r
\r
#endif\r
\r
\r
/**\r
  \r
  Macro that calls DebugAssert() if a protocol is already installed in the \r
  handle database.\r
\r
  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
  then return.\r
\r
  If Handle is NULL, then a check is made to see if the protocol specified by Guid \r
  is present on any handle in the handle database.  If Handle is not NULL, then \r
  a check is made to see if the protocol specified by Guid is present on the \r
  handle specified by Handle.  If the check finds the protocol, then DebugAssert() \r
  is called passing in the source filename, source line number, and Guid.\r
\r
  If Guid is NULL, then ASSERT().\r
\r
  @param  Handle  The handle to check for the protocol.  This is an optional \r
                  parameter that may be NULL.  If it is NULL, then the entire \r
                  handle database is searched.\r
\r
  @param  Guid    Pointer to a protocol GUID.\r
\r
**/\r
#ifdef EFI_DEBUG\r
#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)                               \\r
  do {                                                                                \\r
    if (DebugAssertEnabled ()) {                                                      \\r
      VOID  *Instance;                                                                \\r
      ASSERT (Guid != NULL);                                                          \\r
      if (Handle == NULL) {                                                           \\r
        if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) {   \\r
          _ASSERT (Guid already installed in database);                               \\r
        }                                                                             \\r
      } else {                                                                        \\r
        if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \\r
          _ASSERT (Guid already installed on Handle);                                 \\r
        }                                                                             \\r
      }                                                                               \\r
    }                                                                                 \\r
  } while (FALSE)\r
#else\r
#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)                               \\r
   do {} while(0);\r
#endif\r
\r
\r
/**\r
  Macro that marks the beginning of debug source code.\r
\r
  If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro marks the beginning of source code that is included in a module.\r
  Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() \r
  are not included in a module.\r
\r
**/\r
#define DEBUG_CODE_BEGIN()  do { if (DebugCodeEnabled ()) { UINT8  __DebugCodeLocal\r
\r
\r
/**\r
  \r
  Macro that marks the end of debug source code.\r
\r
  If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro marks the end of source code that is included in a module.  \r
  Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() \r
  are not included in a module.\r
\r
**/\r
#define DEBUG_CODE_END()    __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r
\r
\r
/**\r
  \r
  Macro that declares a section of debug source code.\r
\r
  If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
  then the source code specified by Expression is included in a module.  \r
  Otherwise, the source specified by Expression is not included in a module.\r
\r
**/\r
#define DEBUG_CODE(Expression)  \\r
  DEBUG_CODE_BEGIN ();          \\r
  Expression                    \\r
  DEBUG_CODE_END ()\r
\r
\r
/**\r
  \r
  Macro that calls DebugClearMemory() to clear a buffer to a default value.\r
\r
  If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, \r
  then this macro calls DebugClearMemory() passing in Address and Length.\r
\r
  @param  Address  Pointer to a buffer.\r
  @param  Length   The number of bytes in the buffer to set.\r
\r
**/\r
#define DEBUG_CLEAR_MEMORY(Address, Length)  \\r
  do {                                       \\r
    if (DebugClearMemoryEnabled ()) {        \\r
      DebugClearMemory (Address, Length);    \\r
    }                                        \\r
  } while (FALSE)\r
\r
\r
/**\r
\r
  Macro that calls DebugAssert() if the containing record does not have a \r
  matching signature.  If the signatures matches, then a pointer to the data \r
  structure that contains a specified field of that data structure is returned.  \r
  This is a light weight method hide information by placing a public data \r
  structure inside a larger private data structure and using a pointer to the \r
  public data structure to retrieve a pointer to the private data structure.\r
\r
  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
  then this macro computes the offset, in bytes, of field specified by Field \r
  from the beginning of the  data structure specified by TYPE.  This offset is \r
  subtracted from Record, and is used to return a pointer to a data structure \r
  of the type specified by TYPE.\r
\r
  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,  \r
  then this macro computes the offset, in bytes, of field specified by Field from \r
  the beginning of the data structure specified by TYPE.  This offset is \r
  subtracted from Record, and is used to compute a pointer to a data structure of \r
  the type specified by TYPE.  The Signature field of the data structure specified \r
  by TYPE is compared to TestSignature.  If the signatures match, then a pointer \r
  to the pointer to a data structure of the type specified by TYPE is returned.  \r
  If the signatures do not match, then DebugAssert() is called with a description \r
  of "CR has a bad signature" and Record is returned.  \r
\r
  If the data type specified by TYPE does not contain the field specified by Field, \r
  then the module will not compile.\r
\r
  If TYPE does not contain a field called Signature, then the module will not \r
  compile.\r
\r
  @param  Record         Pointer to the field specified by Field within a data \r
                         structure of type TYPE.\r
\r
  @param  TYPE           The name of the data structure type to return  This \r
                         data structure must contain the field specified by Field. \r
\r
  @param  Field          The name of the field in the data structure specified \r
                         by TYPE to which Record points.\r
\r
  @param  TestSignature  The 32-bit signature value to match.\r
\r
**/\r
#ifdef EFI_DEBUG\r
  #define CR(Record, TYPE, Field, TestSignature)                                          \\r
    (DebugAssertEnabled () && (_CR (Record, TYPE, Field)->Signature != TestSignature)) ?  \\r
    (TYPE *) (_ASSERT (CR has Bad Signature), Record) :                                   \\r
    _CR (Record, TYPE, Field)\r
#else\r
  #define CR(Record, TYPE, Field, TestSignature)                                          \\r
          _CR (Record, TYPE, Field)\r
#endif\r
\r
\r
#endif\r
Commit	Line	Data
3eb9473e	1	/*++\r
	2	\r
	3	Copyright (c) 2004 - 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	\r
	13	Module Name:\r
	14	\r
	15	EdkIIGlueDebugLib.h\r
	16	\r
	17	Abstract: \r
	18	\r
	19	Public include file for the Debug Library\r
	20	\r
	21	--*/\r
	22	\r
	23	#ifndef __EDKII_GLUE_DEBUG_LIB_H__\r
	24	#define __EDKII_GLUE_DEBUG_LIB_H__\r
	25	\r
	26	//\r
	27	// To use EdkII code, these R8.x macros are undefined\r
	28	//\r
	29	#undef ASSERT\r
	30	#undef DEBUG\r
	31	#undef ASSERT_EFI_ERROR\r
	32	#undef ASSERT_PROTOCOL_ALREADY_INSTALLED\r
	33	#undef DEBUG_CODE\r
	34	#undef CR\r
	35	\r
	36	#undef EFI_D_INIT\r
	37	#undef EFI_D_WARN\r
	38	#undef EFI_D_LOAD\r
	39	#undef EFI_D_FS\r
	40	#undef EFI_D_POOL\r
	41	#undef EFI_D_PAGE\r
	42	#undef EFI_D_INFO\r
	43	#undef EFI_D_VARIABLE\r
	44	#undef EFI_D_BM \r
	45	#undef EFI_D_BLKIO\r
	46	#undef EFI_D_NET \r
	47	#undef EFI_D_UNDI\r
	48	#undef EFI_D_LOADFILE\r
	49	#undef EFI_D_EVENT\r
	50	#undef EFI_D_ERROR\r
	51	\r
	52	//\r
	53	// Declare bits for PcdDebugPropertyMask\r
	54	//\r
	55	#define DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED 0x01\r
	56	#define DEBUG_PROPERTY_DEBUG_PRINT_ENABLED 0x02\r
	57	#define DEBUG_PROPERTY_DEBUG_CODE_ENABLED 0x04\r
	58	#define DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED 0x08\r
	59	#define DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED 0x10\r
	60	#define DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED 0x20\r
	61	\r
	62	//\r
	63	// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()\r
	64	//\r
65	#define DEBUG_INIT 0x00000001 // Initialization\r
66	#define DEBUG_WARN 0x00000002 // Warnings\r
67	#define DEBUG_LOAD 0x00000004 // Load events\r
68	#define DEBUG_FS 0x00000008 // EFI File system\r
69	#define DEBUG_POOL 0x00000010 // Alloc & Free's\r
70	#define DEBUG_PAGE 0x00000020 // Alloc & Free's\r
71	#define DEBUG_INFO 0x00000040 // Verbose\r
72	#define DEBUG_VARIABLE 0x00000100 // Variable\r
73	#define DEBUG_BM 0x00000400 // Boot Manager\r
74	#define DEBUG_BLKIO 0x00001000 // BlkIo Driver\r
75	#define DEBUG_NET 0x00004000 // SNI Driver\r
76	#define DEBUG_UNDI 0x00010000 // UNDI Driver\r
77	#define DEBUG_LOADFILE 0x00020000 // UNDI Driver\r
78	#define DEBUG_EVENT 0x00080000 // Event messages\r
79	#define DEBUG_ERROR 0x80000000 // Error\r
80	\r
81	//\r
82	// Aliases of debug message mask bits\r
83	//\r
84	#define EFI_D_INIT DEBUG_INIT\r
85	#define EFI_D_WARN DEBUG_WARN\r
86	#define EFI_D_LOAD DEBUG_LOAD\r
87	#define EFI_D_FS DEBUG_FS\r
88	#define EFI_D_POOL DEBUG_POOL\r
89	#define EFI_D_PAGE DEBUG_PAGE\r
90	#define EFI_D_INFO DEBUG_INFO\r
91	#define EFI_D_VARIABLE DEBUG_VARIABLE\r
92	#define EFI_D_BM DEBUG_BM\r
93	#define EFI_D_BLKIO DEBUG_BLKIO\r
94	#define EFI_D_NET DEBUG_NET\r
95	#define EFI_D_UNDI DEBUG_UNDI\r
96	#define EFI_D_LOADFILE DEBUG_LOADFILE\r
97	#define EFI_D_EVENT DEBUG_EVENT\r
98	#define EFI_D_ERROR DEBUG_ERROR\r
99	\r
c7f33ca4	100	\r
	101	//\r
	102	// Use the following 4 macros to save size\r
	103	//\r
	104	#define DebugAssertEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0))\r
	105	\r
	106	#define DebugPrintEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0))\r
	107	\r
	108	#define DebugCodeEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0))\r
	109	\r
	110	#define DebugClearMemoryEnabled() ((BOOLEAN)((__EDKII_GLUE_PCD_PcdDebugPropertyMask__ & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0))\r
	111	\r
	112	\r
3eb9473e	113	/**\r
	114	\r
	115	Prints a debug message to the debug output device if the specified error level is enabled.\r
	116	\r
	117	If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
	118	the message specified by Format and the associated variable argument list to \r
	119	the debug output device.\r
	120	\r
	121	If Format is NULL, then ASSERT().\r
	122	\r
	123	@param ErrorLevel The error level of the debug message.\r
	124	@param Format Format string for the debug message to print.\r
	125	\r
	126	**/\r
	127	VOID\r
	128	EFIAPI\r
	129	DebugPrint (\r
	130	IN UINTN ErrorLevel,\r
	131	IN CONST CHAR8 *Format,\r
	132	...\r
	133	);\r
	134	\r
	135	\r
	136	/**\r
	137	\r
	138	Prints an assert message containing a filename, line number, and description. \r
	139	This may be followed by a breakpoint or a dead loop.\r
	140	\r
	141	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
	142	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
	143	PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
	144	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
	145	CpuDeadLoop() is called. If neither of these bits are set, then this function \r
	146	returns immediately after the message is printed to the debug output device.\r
	147	DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
	148	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	149	\r
	150	If FileName is NULL, then a <FileName> string of ?NULL) Filename?is printed.\r
	151	\r
	152	If Description is NULL, then a <Description> string of ?NULL) Description?is printed.\r
	153	\r
	154	@param FileName Pointer to the name of the source file that generated the assert condition.\r
	155	@param LineNumber The line number in the source file that generated the assert condition\r
	156	@param Description Pointer to the description of the assert condition.\r
	157	\r
	158	**/\r
	159	VOID\r
	160	EFIAPI\r
	161	DebugAssert (\r
	162	IN CONST CHAR8 *FileName,\r
	163	IN UINTN LineNumber,\r
	164	IN CONST CHAR8 *Description\r
	165	);\r
	166	\r
	167	\r
	168	/**\r
	169	\r
	170	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	171	\r
	172	This function fills Length bytes of Buffer with the value specified by \r
	173	PcdDebugClearMemoryValue, and returns Buffer.\r
	174	\r
	175	If Buffer is NULL, then ASSERT().\r
	176	\r
177	If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT(). \r
178	\r
179	@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
180	@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
181	\r
182	@return Buffer\r
183	\r
184	**/\r
185	VOID *\r
186	EFIAPI\r
187	DebugClearMemory (\r
188	OUT VOID *Buffer,\r
189	IN UINTN Length\r
190	);\r
191	\r
192	\r
3eb9473e	193	/**\r
	194	\r
	195	Internal worker macro that calls DebugAssert().\r
	196	\r
	197	This macro calls DebugAssert() passing in the filename, line number, and \r
	198	expression that evailated to FALSE.\r
	199	\r
	200	@param Expression Boolean expression that evailated to FALSE\r
	201	\r
	202	**/\r
c7f33ca4	203	#ifdef EFI_DEBUG\r
3eb9473e	204	#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)\r
c7f33ca4	205	#else\r
c7f33ca4	206	#define _ASSERT(Expression)\r
3eb9473e	207	\r
c7f33ca4	208	#endif\r
3eb9473e	209	\r
	210	/**\r
	211	\r
	212	Internal worker macro that calls DebugPrint().\r
	213	\r
	214	This macro calls DebugPrint() passing in the debug error level, a format \r
	215	string, and a variable argument list.\r
	216	\r
	217	@param Expression Expression containing an error level, a format string, \r
	218	and a variable argument list based on the format string.\r
	219	\r
	220	**/\r
c7f33ca4	221	#ifdef EFI_DEBUG\r
3eb9473e	222	#define _DEBUG(Expression) DebugPrint Expression\r
c7f33ca4	223	#else\r
c7f33ca4	224	#define _DEBUG(Expression)\r
3eb9473e	225	\r
c7f33ca4	226	#endif\r
3eb9473e	227	\r
	228	/**\r
	229	\r
	230	Macro that calls DebugAssert() if a expression evaluates to FALSE.\r
	231	\r
	232	If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
	233	then this macro evaluates the Boolean expression specified by Expression. If \r
	234	Expression evaluates to FALSE, then DebugAssert() is called passing in the \r
	235	source filename, source line number, and Expression.\r
	236	\r
	237	@param Expression Boolean expression\r
	238	\r
	239	**/\r
	240	#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
	241	// Glue Library internal\r
	242	\r
	243	#if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
	244	#ifdef EFI_DEBUG\r
	245	#define ASSERT(Expression) \\r
	246	do { \\r
	247	if (DebugAssertEnabled ()) { \\r
	248	if (!(Expression)) { \\r
	249	_ASSERT (Expression); \\r
	250	} \\r
	251	} \\r
	252	} while (FALSE)\r
	253	#endif\r
	254	#else\r
	255	#define ASSERT(Expression) do{} while(0)\r
	256	#endif \r
	257	\r
	258	#else\r
	259	// External usage\r
	260	\r
	261	#ifdef EFI_DEBUG\r
	262	#define ASSERT(Expression) \\r
	263	do { \\r
	264	if (DebugAssertEnabled ()) { \\r
	265	if (!(Expression)) { \\r
	266	_ASSERT (Expression); \\r
	267	} \\r
	268	} \\r
	269	} while (FALSE)\r
	270	#else\r
	271	#define ASSERT(Expression) do{} while(0)\r
	272	#endif\r
	273	\r
	274	#endif\r
	275	\r
	276	/**\r
	277	\r
	278	Macro that calls DebugPrint().\r
	279	\r
	280	If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set, \r
	281	then this macro passes Expression to DebugPrint().\r
	282	\r
	283	@param Expression Expression containing an error level, a format string, \r
	284	and a variable argument list based on the format string.\r
	285	\r
	286	\r
	287	**/\r
	288	#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
	289	// Glue Library internal\r
	290	\r
291	#if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
292	#ifdef EFI_DEBUG\r
293	#define DEBUG(Expression) \\r
294	do { \\r
295	if (DebugPrintEnabled ()) { \\r
296	_DEBUG (Expression); \\r
297	} \\r
298	} while (FALSE)\r
299	#endif\r
300	#else\r
301	#define DEBUG(Expression) do{} while(0)\r
302	#endif \r
303	\r
304	#else\r
305	// External usage\r
306	\r
307	#ifdef EFI_DEBUG\r
308	#define DEBUG(Expression) \\r
309	do { \\r
310	if (DebugPrintEnabled ()) { \\r
311	_DEBUG (Expression); \\r
312	} \\r
313	} while (FALSE)\r
314	#else\r
315	#define DEBUG(Expression) do{} while(0)\r
316	#endif\r
317	\r
318	#endif\r
319	\r
320	\r
321	/**\r
322	\r
323	Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.\r
324	\r
325	If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
326	then this macro evaluates the EFI_STATUS value specified by StatusParameter. \r
327	If StatusParameter is an error code, then DebugAssert() is called passing in \r
328	the source filename, source line number, and StatusParameter.\r
329	\r
330	@param StatusParameter EFI_STATUS value to evaluate.\r
331	\r
332	**/\r
333	#ifdef EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
334	// Glue Library internal\r
335	\r
336	#if EDKII_GLUE_LIBRARY_DEBUG_ENABLE\r
337	#ifdef EFI_DEBUG\r
338	#define ASSERT_EFI_ERROR(StatusParameter) \\r
339	do { \\r
340	if (DebugAssertEnabled ()) { \\r
341	if (EFI_ERROR (StatusParameter)) { \\r
342	DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \\r
343	_ASSERT (!EFI_ERROR (StatusParameter)); \\r
344	} \\r
345	} \\r
346	} while (FALSE)\r
347	#endif\r
348	#else\r
349	#define ASSERT_EFI_ERROR(Expression) do{} while(0)\r
350	#endif \r
351	\r
352	#else\r
353	// External usage\r
354	\r
355	#ifdef EFI_DEBUG\r
356	#define ASSERT_EFI_ERROR(StatusParameter) \\r
357	do { \\r
358	if (DebugAssertEnabled ()) { \\r
359	if (EFI_ERROR (StatusParameter)) { \\r
360	DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \\r
361	_ASSERT (!EFI_ERROR (StatusParameter)); \\r
362	} \\r
363	} \\r
364	} while (FALSE)\r
365	#else\r
366	#define ASSERT_EFI_ERROR(Expression) do{} while(0)\r
367	#endif\r
368	\r
369	#endif\r
370	\r
371	\r
372	/**\r
373	\r
374	Macro that calls DebugAssert() if a protocol is already installed in the \r
375	handle database.\r
376	\r
377	If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
378	then return.\r
379	\r
380	If Handle is NULL, then a check is made to see if the protocol specified by Guid \r
381	is present on any handle in the handle database. If Handle is not NULL, then \r
382	a check is made to see if the protocol specified by Guid is present on the \r
383	handle specified by Handle. If the check finds the protocol, then DebugAssert() \r
384	is called passing in the source filename, source line number, and Guid.\r
385	\r
386	If Guid is NULL, then ASSERT().\r
387	\r
388	@param Handle The handle to check for the protocol. This is an optional \r
389	parameter that may be NULL. If it is NULL, then the entire \r
390	handle database is searched.\r
391	\r
392	@param Guid Pointer to a protocol GUID.\r
393	\r
394	**/\r
c7f33ca4	395	#ifdef EFI_DEBUG\r
3eb9473e	396	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \\r
	397	do { \\r
	398	if (DebugAssertEnabled ()) { \\r
	399	VOID *Instance; \\r
	400	ASSERT (Guid != NULL); \\r
	401	if (Handle == NULL) { \\r
	402	if (!EFI_ERROR (gBS->LocateProtocol ((EFI_GUID *)Guid, NULL, &Instance))) { \\r
	403	_ASSERT (Guid already installed in database); \\r
	404	} \\r
	405	} else { \\r
	406	if (!EFI_ERROR (gBS->HandleProtocol (Handle, (EFI_GUID *)Guid, &Instance))) { \\r
	407	_ASSERT (Guid already installed on Handle); \\r
	408	} \\r
	409	} \\r
	410	} \\r
	411	} while (FALSE)\r
c7f33ca4	412	#else\r
	413	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \\r
	414	do {} while(0);\r
	415	#endif\r
3eb9473e	416	\r
	417	\r
	418	/**\r
	419	Macro that marks the beginning of debug source code.\r
	420	\r
	421	If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
	422	then this macro marks the beginning of source code that is included in a module.\r
	423	Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() \r
	424	are not included in a module.\r
	425	\r
	426	**/\r
	427	#define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal\r
	428	\r
	429	\r
	430	/**\r
	431	\r
	432	Macro that marks the end of debug source code.\r
	433	\r
	434	If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
	435	then this macro marks the end of source code that is included in a module. \r
	436	Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() \r
	437	are not included in a module.\r
	438	\r
	439	**/\r
	440	#define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r
	441	\r
	442	\r
	443	/**\r
	444	\r
	445	Macro that declares a section of debug source code.\r
	446	\r
	447	If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
	448	then the source code specified by Expression is included in a module. \r
	449	Otherwise, the source specified by Expression is not included in a module.\r
	450	\r
	451	**/\r
	452	#define DEBUG_CODE(Expression) \\r
	453	DEBUG_CODE_BEGIN (); \\r
	454	Expression \\r
	455	DEBUG_CODE_END ()\r
	456	\r
	457	\r
	458	/**\r
	459	\r
	460	Macro that calls DebugClearMemory() to clear a buffer to a default value.\r
	461	\r
	462	If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, \r
	463	then this macro calls DebugClearMemory() passing in Address and Length.\r
	464	\r
	465	@param Address Pointer to a buffer.\r
	466	@param Length The number of bytes in the buffer to set.\r
	467	\r
	468	**/\r
	469	#define DEBUG_CLEAR_MEMORY(Address, Length) \\r
	470	do { \\r
	471	if (DebugClearMemoryEnabled ()) { \\r
	472	DebugClearMemory (Address, Length); \\r
	473	} \\r
	474	} while (FALSE)\r
	475	\r
	476	\r
	477	/**\r
	478	\r
	479	Macro that calls DebugAssert() if the containing record does not have a \r
480	matching signature. If the signatures matches, then a pointer to the data \r
481	structure that contains a specified field of that data structure is returned. \r
482	This is a light weight method hide information by placing a public data \r
483	structure inside a larger private data structure and using a pointer to the \r
484	public data structure to retrieve a pointer to the private data structure.\r
485	\r
486	If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
487	then this macro computes the offset, in bytes, of field specified by Field \r
488	from the beginning of the data structure specified by TYPE. This offset is \r
489	subtracted from Record, and is used to return a pointer to a data structure \r
490	of the type specified by TYPE.\r
491	\r
492	If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r
493	then this macro computes the offset, in bytes, of field specified by Field from \r
494	the beginning of the data structure specified by TYPE. This offset is \r
495	subtracted from Record, and is used to compute a pointer to a data structure of \r
496	the type specified by TYPE. The Signature field of the data structure specified \r
497	by TYPE is compared to TestSignature. If the signatures match, then a pointer \r
498	to the pointer to a data structure of the type specified by TYPE is returned. \r
499	If the signatures do not match, then DebugAssert() is called with a description \r
500	of "CR has a bad signature" and Record is returned. \r
501	\r
502	If the data type specified by TYPE does not contain the field specified by Field, \r
503	then the module will not compile.\r
504	\r
505	If TYPE does not contain a field called Signature, then the module will not \r
506	compile.\r
507	\r
508	@param Record Pointer to the field specified by Field within a data \r
509	structure of type TYPE.\r
510	\r
511	@param TYPE The name of the data structure type to return This \r
512	data structure must contain the field specified by Field. \r
513	\r
514	@param Field The name of the field in the data structure specified \r
515	by TYPE to which Record points.\r
516	\r
517	@param TestSignature The 32-bit signature value to match.\r
518	\r
519	**/\r
c7f33ca4	520	#ifdef EFI_DEBUG\r
	521	#define CR(Record, TYPE, Field, TestSignature) \\r
	522	(DebugAssertEnabled () && (_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \\r
	523	(TYPE *) (_ASSERT (CR has Bad Signature), Record) : \\r
	524	_CR (Record, TYPE, Field)\r
	525	#else\r
	526	#define CR(Record, TYPE, Field, TestSignature) \\r
	527	_CR (Record, TYPE, Field)\r
	528	#endif\r
	529	\r
	530	\r
3eb9473e	531	#endif\r