2 UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.
4 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include <Library/DebugLib.h>
12 #include <Library/PrintLib.h>
13 #include <Library/PcdLib.h>
14 #include <Library/BaseLib.h>
15 #include <Library/BaseMemoryLib.h>
16 #include <Library/DebugPrintErrorLevelLib.h>
19 // Define the maximum debug and assert message length that this library supports
21 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
24 // VA_LIST can not initialize to NULL for all compiler, so we use this to
25 // indicate a null VA_LIST
29 extern BOOLEAN mPostEBS
;
30 extern EFI_SYSTEM_TABLE
*mDebugST
;
33 Prints a debug message to the debug output device if the specified error level is enabled.
35 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
36 GetDebugPrintErrorLevel (), then print the message specified by Format and the
37 associated variable argument list to the debug output device.
39 If Format is NULL, then ASSERT().
41 @param ErrorLevel The error level of the debug message.
42 @param Format Format string for the debug message to print.
43 @param ... A variable argument list whose contents are accessed
44 based on the format string specified by Format.
51 IN CONST CHAR8
*Format
,
57 VA_START (Marker
, Format
);
58 DebugVPrint (ErrorLevel
, Format
, Marker
);
63 Prints a debug message to the debug output device if the specified
64 error level is enabled base on Null-terminated format string and a
65 VA_LIST argument list or a BASE_LIST argument list.
67 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
68 GetDebugPrintErrorLevel (), then print the message specified by Format and
69 the associated variable argument list to the debug output device.
71 If Format is NULL, then ASSERT().
73 @param ErrorLevel The error level of the debug message.
74 @param Format Format string for the debug message to print.
75 @param VaListMarker VA_LIST marker for the variable argument list.
76 @param BaseListMarker BASE_LIST marker for the variable argument list.
82 IN CONST CHAR8
*Format
,
83 IN VA_LIST VaListMarker
,
84 IN BASE_LIST BaseListMarker
87 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
91 // If Format is NULL, then ASSERT().
93 ASSERT (Format
!= NULL
);
96 // Check driver debug mask value and global mask
98 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) {
103 // Convert the DEBUG() message to a Unicode String
105 if (BaseListMarker
== NULL
) {
106 UnicodeVSPrintAsciiFormat (Buffer
, sizeof (Buffer
), Format
, VaListMarker
);
108 UnicodeBSPrintAsciiFormat (Buffer
, sizeof (Buffer
), Format
, BaseListMarker
);
112 // Send the print string to the Console Output device
114 if ((mDebugST
!= NULL
) && (mDebugST
->ConOut
!= NULL
)) {
115 mDebugST
->ConOut
->OutputString (mDebugST
->ConOut
, Buffer
);
121 Prints a debug message to the debug output device if the specified
122 error level is enabled.
124 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
125 GetDebugPrintErrorLevel (), then print the message specified by Format and
126 the associated variable argument list to the debug output device.
128 If Format is NULL, then ASSERT().
130 @param ErrorLevel The error level of the debug message.
131 @param Format Format string for the debug message to print.
132 @param VaListMarker VA_LIST marker for the variable argument list.
139 IN CONST CHAR8
*Format
,
140 IN VA_LIST VaListMarker
143 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
147 Prints a debug message to the debug output device if the specified
148 error level is enabled.
149 This function use BASE_LIST which would provide a more compatible
150 service than VA_LIST.
152 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
153 GetDebugPrintErrorLevel (), then print the message specified by Format and
154 the associated variable argument list to the debug output device.
156 If Format is NULL, then ASSERT().
158 @param ErrorLevel The error level of the debug message.
159 @param Format Format string for the debug message to print.
160 @param BaseListMarker BASE_LIST marker for the variable argument list.
167 IN CONST CHAR8
*Format
,
168 IN BASE_LIST BaseListMarker
171 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
175 Prints an assert message containing a filename, line number, and description.
176 This may be followed by a breakpoint or a dead loop.
178 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
179 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
180 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
181 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
182 CpuDeadLoop() is called. If neither of these bits are set, then this function
183 returns immediately after the message is printed to the debug output device.
184 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
185 processing another DebugAssert(), then DebugAssert() must return immediately.
187 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
188 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
190 @param FileName The pointer to the name of the source file that generated
191 the assert condition.
192 @param LineNumber The line number in the source file that generated the
194 @param Description The pointer to the description of the assert condition.
200 IN CONST CHAR8
*FileName
,
202 IN CONST CHAR8
*Description
205 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
209 // Generate the ASSERT() message in Unicode format
211 UnicodeSPrintAsciiFormat (
214 "ASSERT [%a] %a(%d): %a\n",
222 // Send the print string to the Console Output device
224 if ((mDebugST
!= NULL
) && (mDebugST
->ConOut
!= NULL
)) {
225 mDebugST
->ConOut
->OutputString (mDebugST
->ConOut
, Buffer
);
229 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
231 if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
233 } else if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
240 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
242 This function fills Length bytes of Buffer with the value specified by
243 PcdDebugClearMemoryValue, and returns Buffer.
245 If Buffer is NULL, then ASSERT().
246 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
248 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
249 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
251 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
262 // If Buffer is NULL, then ASSERT().
264 ASSERT (Buffer
!= NULL
);
267 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
269 return SetMem (Buffer
, Length
, PcdGet8 (PcdDebugClearMemoryValue
));
273 Returns TRUE if ASSERT() macros are enabled.
275 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
276 PcdDebugProperyMask is set. Otherwise FALSE is returned.
278 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
279 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
288 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
292 Returns TRUE if DEBUG() macros are enabled.
294 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
295 PcdDebugProperyMask is set. Otherwise FALSE is returned.
297 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
298 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
307 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
311 Returns TRUE if DEBUG_CODE() macros are enabled.
313 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
314 PcdDebugProperyMask is set. Otherwise FALSE is returned.
316 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
317 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
326 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
330 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
332 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
333 PcdDebugProperyMask is set. Otherwise FALSE is returned.
335 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
336 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
341 DebugClearMemoryEnabled (
345 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
349 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
351 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
353 @retval TRUE Current ErrorLevel is supported.
354 @retval FALSE Current ErrorLevel is not supported.
359 DebugPrintLevelEnabled (
360 IN CONST UINTN ErrorLevel
363 return (BOOLEAN
)((ErrorLevel
& PcdGet32 (PcdFixedDebugPrintErrorLevel
)) != 0);