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 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/DebugLib.h>
18 #include <Library/UefiBootServicesTableLib.h>
19 #include <Library/PrintLib.h>
20 #include <Library/PcdLib.h>
21 #include <Library/BaseLib.h>
22 #include <Library/BaseMemoryLib.h>
23 #include <Library/DebugPrintErrorLevelLib.h>
26 // Define the maximum debug and assert message length that this library supports
28 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
31 // VA_LIST can not initialize to NULL for all compiler, so we use this to
32 // indicate a null VA_LIST
37 Prints a debug message to the debug output device if the specified error level is enabled.
39 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
40 GetDebugPrintErrorLevel (), then print the message specified by Format and the
41 associated variable argument list to the debug output device.
43 If Format is NULL, then ASSERT().
45 @param ErrorLevel The error level of the debug message.
46 @param Format Format string for the debug message to print.
47 @param ... A variable argument list whose contents are accessed
48 based on the format string specified by Format.
55 IN CONST CHAR8
*Format
,
61 VA_START (Marker
, Format
);
62 DebugVPrint (ErrorLevel
, Format
, Marker
);
68 Prints a debug message to the debug output device if the specified
69 error level is enabled base on Null-terminated format string and a
70 VA_LIST argument list or a BASE_LIST argument list.
72 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
73 GetDebugPrintErrorLevel (), then print the message specified by Format and
74 the associated variable argument list to the debug output device.
76 If Format is NULL, then ASSERT().
78 @param ErrorLevel The error level of the debug message.
79 @param Format Format string for the debug message to print.
80 @param VaListMarker VA_LIST marker for the variable argument list.
81 @param BaseListMarker BASE_LIST marker for the variable argument list.
87 IN CONST CHAR8
*Format
,
88 IN VA_LIST VaListMarker
,
89 IN BASE_LIST BaseListMarker
92 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
95 // If Format is NULL, then ASSERT().
97 ASSERT (Format
!= NULL
);
100 // Check driver debug mask value and global mask
102 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) {
107 // Convert the DEBUG() message to a Unicode String
109 if (BaseListMarker
== NULL
) {
110 UnicodeVSPrintAsciiFormat (Buffer
, MAX_DEBUG_MESSAGE_LENGTH
, Format
, VaListMarker
);
112 UnicodeBSPrintAsciiFormat (Buffer
, MAX_DEBUG_MESSAGE_LENGTH
, Format
, BaseListMarker
);
117 // Send the print string to the Console Output device
119 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
120 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
126 Prints a debug message to the debug output device if the specified
127 error level is enabled.
129 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
130 GetDebugPrintErrorLevel (), then print the message specified by Format and
131 the associated variable argument list to the debug output device.
133 If Format is NULL, then ASSERT().
135 @param ErrorLevel The error level of the debug message.
136 @param Format Format string for the debug message to print.
137 @param VaListMarker VA_LIST marker for the variable argument list.
144 IN CONST CHAR8
*Format
,
145 IN VA_LIST VaListMarker
148 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
153 Prints a debug message to the debug output device if the specified
154 error level is enabled.
155 This function use BASE_LIST which would provide a more compatible
156 service than VA_LIST.
158 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
159 GetDebugPrintErrorLevel (), then print the message specified by Format and
160 the associated variable argument list to the debug output device.
162 If Format is NULL, then ASSERT().
164 @param ErrorLevel The error level of the debug message.
165 @param Format Format string for the debug message to print.
166 @param BaseListMarker BASE_LIST marker for the variable argument list.
173 IN CONST CHAR8
*Format
,
174 IN BASE_LIST BaseListMarker
177 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
182 Prints an assert message containing a filename, line number, and description.
183 This may be followed by a breakpoint or a dead loop.
185 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
186 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
187 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
188 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
189 CpuDeadLoop() is called. If neither of these bits are set, then this function
190 returns immediately after the message is printed to the debug output device.
191 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
192 processing another DebugAssert(), then DebugAssert() must return immediately.
194 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
195 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
197 @param FileName The pointer to the name of the source file that generated
198 the assert condition.
199 @param LineNumber The line number in the source file that generated the
201 @param Description The pointer to the description of the assert condition.
207 IN CONST CHAR8
*FileName
,
209 IN CONST CHAR8
*Description
212 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
215 // Generate the ASSERT() message in Unicode format
217 UnicodeSPrintAsciiFormat (
220 "ASSERT [%a] %a(%d): %a\n",
228 // Send the print string to the Console Output device
230 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
231 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
235 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
237 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
239 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
246 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
248 This function fills Length bytes of Buffer with the value specified by
249 PcdDebugClearMemoryValue, and returns Buffer.
251 If Buffer is NULL, then ASSERT().
252 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
254 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
255 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
257 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
268 // If Buffer is NULL, then ASSERT().
270 ASSERT (Buffer
!= NULL
);
273 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
275 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
280 Returns TRUE if ASSERT() macros are enabled.
282 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
283 PcdDebugProperyMask is set. Otherwise FALSE is returned.
285 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
286 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
295 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
300 Returns TRUE if DEBUG() macros are enabled.
302 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
303 PcdDebugProperyMask is set. Otherwise FALSE is returned.
305 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
306 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
315 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
320 Returns TRUE if DEBUG_CODE() macros are enabled.
322 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
323 PcdDebugProperyMask is set. Otherwise FALSE is returned.
325 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
326 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
335 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
340 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
342 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
343 PcdDebugProperyMask is set. Otherwise FALSE is returned.
345 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
346 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
351 DebugClearMemoryEnabled (
355 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
359 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
361 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
363 @retval TRUE Current ErrorLevel is supported.
364 @retval FALSE Current ErrorLevel is not supported.
369 DebugPrintLevelEnabled (
370 IN CONST UINTN ErrorLevel
373 return (BOOLEAN
) ((ErrorLevel
& PcdGet32(PcdFixedDebugPrintErrorLevel
)) != 0);