/** @file\r
- Public include file for the Debug Library\r
-\r
- Copyright (c) 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
+ Provides services to print debug and assert messages to a debug output device.\r
+ \r
+ The Debug library supports debug print and asserts based on a combination of macros and code.\r
+ The debug library can be turned on and off so that the debug code does not increase the size of an image.\r
+ \r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
+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
\r
//\r
// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()\r
//\r
-#define EFI_D_INIT 0x00000001 // Initialization style messages\r
-#define EFI_D_WARN 0x00000002 // Warnings\r
-#define EFI_D_LOAD 0x00000004 // Load events\r
-#define EFI_D_FS 0x00000008 // EFI File system\r
-#define EFI_D_POOL 0x00000010 // Alloc & Free's\r
-#define EFI_D_PAGE 0x00000020 // Alloc & Free's\r
-#define EFI_D_INFO 0x00000040 // Verbose\r
-#define EFI_D_VARIABLE 0x00000100 // Variable\r
-#define EFI_D_BM 0x00000400 // Boot Manager (BDS)\r
-#define EFI_D_BLKIO 0x00001000 // BlkIo Driver\r
-#define EFI_D_NET 0x00004000 // SNI Driver\r
-#define EFI_D_UNDI 0x00010000 // UNDI Driver\r
-#define EFI_D_LOADFILE 0x00020000 // UNDI Driver\r
-#define EFI_D_EVENT 0x00080000 // Event messages\r
-#define EFI_D_ERROR 0x80000000 // Error\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_DISPATCH 0x00000080 // PEI/DXE Dispatchers\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
+//\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_DISPATCH DEBUG_DISPATCH\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
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
\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... Variable argument list whose contents are accessed \r
+ based on the format string specified by Format.\r
\r
**/\r
VOID\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
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
+ DebugAssert() must actively prevent recursion. 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
+ If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\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
\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
+ If Length is greater than (MAX_ADDRESS -Buffer + 1), 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 Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer\r
+ @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
\r
\r
/**\r
- \r
Returns TRUE if ASSERT() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
);\r
\r
\r
-/**\r
- \r
- Returns TRUE if DEBUG()macros are enabled.\r
+/** \r
+ Returns TRUE if DEBUG() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
);\r
\r
\r
-/**\r
- \r
- Returns TRUE if DEBUG_CODE()macros are enabled.\r
+/** \r
+ Returns TRUE if DEBUG_CODE() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
);\r
\r
\r
-/**\r
- \r
- Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
+/** \r
+ Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
);\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
#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)\r
\r
\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
#define _DEBUG(Expression) DebugPrint Expression\r
\r
\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
} while (FALSE)\r
\r
\r
-/**\r
- \r
+/** \r
Macro that calls DebugPrint().\r
\r
If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set, \r
} while (FALSE)\r
\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
} while (FALSE)\r
\r
\r
-/**\r
- \r
+/** \r
Macro that calls DebugAssert() if a protocol is already installed in the \r
handle database.\r
\r
#define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal\r
\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
#define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r
\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
DEBUG_CODE_END ()\r
\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
\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
@param TestSignature The 32-bit signature value to match.\r
\r
**/\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
+#define CR(Record, TYPE, Field, TestSignature) \\r
+ (DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \\r
+ (TYPE *) (_ASSERT (CR has Bad Signature), Record) : \\r
+ BASE_CR (Record, TYPE, Field)\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff