2 UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.
4 Copyright (c) 2006 - 2008, 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.
18 #include <Library/DebugLib.h>
19 #include <Library/UefiBootServicesTableLib.h>
20 #include <Library/PrintLib.h>
21 #include <Library/PcdLib.h>
22 #include <Library/BaseLib.h>
23 #include <Library/BaseMemoryLib.h>
26 // Define the maximum debug and assert message length that this library supports
28 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
32 Prints a debug message to the debug output device if the specified error level is enabled.
34 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
35 the message specified by Format and the associated variable argument list to
36 the debug output device.
38 If Format is NULL, then ASSERT().
40 @param ErrorLevel The error level of the debug message.
41 @param Format Format string for the debug message to print.
42 @param ... Variable argument list whose contents are accessed
43 based on the format string specified by Format.
50 IN CONST CHAR8
*Format
,
54 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
58 // If Format is NULL, then ASSERT().
60 ASSERT (Format
!= NULL
);
63 // Check driver debug mask value and global mask
65 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
70 // Convert the DEBUG() message to a Unicode String
72 VA_START (Marker
, Format
);
73 UnicodeVSPrintAsciiFormat (Buffer
, MAX_DEBUG_MESSAGE_LENGTH
, Format
, Marker
);
77 // Send the print string to the Standard Error device
79 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
80 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
86 Prints an assert message containing a filename, line number, and description.
87 This may be followed by a breakpoint or a dead loop.
89 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
90 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
91 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
92 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
93 CpuDeadLoop() is called. If neither of these bits are set, then this function
94 returns immediately after the message is printed to the debug output device.
95 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
96 processing another DebugAssert(), then DebugAssert() must return immediately.
98 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
99 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
101 @param FileName The pointer to the name of the source file that generated the assert condition.
102 @param LineNumber The line number in the source file that generated the assert condition
103 @param Description The pointer to the description of the assert condition.
109 IN CONST CHAR8
*FileName
,
111 IN CONST CHAR8
*Description
114 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
117 // Generate the ASSERT() message in Unicode format
119 UnicodeSPrintAsciiFormat (
121 MAX_DEBUG_MESSAGE_LENGTH
,
122 "ASSERT %a(%d): %a\n",
129 // Send the print string to the Standard Error device
131 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
132 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
136 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
138 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
140 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
147 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
149 This function fills Length bytes of Buffer with the value specified by
150 PcdDebugClearMemoryValue, and returns Buffer.
152 If Buffer is NULL, then ASSERT().
153 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
155 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
156 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
158 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
169 // If Buffer is NULL, then ASSERT().
171 ASSERT (Buffer
!= NULL
);
174 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
176 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
181 Returns TRUE if ASSERT() macros are enabled.
183 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
184 PcdDebugProperyMask is set. Otherwise FALSE is returned.
186 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
187 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
196 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
201 Returns TRUE if DEBUG() macros are enabled.
203 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
204 PcdDebugProperyMask is set. Otherwise FALSE is returned.
206 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
207 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
216 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
221 Returns TRUE if DEBUG_CODE() macros are enabled.
223 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
224 PcdDebugProperyMask is set. Otherwise FALSE is returned.
226 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
227 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
236 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
241 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
243 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
244 PcdDebugProperyMask is set. Otherwise FALSE is returned.
246 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
247 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
252 DebugClearMemoryEnabled (
256 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);