2 UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.
4 Copyright (c) 2006 - 2008, Intel Corporation<BR>
5 All rights reserved. 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.
19 #include <Library/DebugLib.h>
20 #include <Library/UefiBootServicesTableLib.h>
21 #include <Library/PrintLib.h>
22 #include <Library/PcdLib.h>
23 #include <Library/BaseLib.h>
24 #include <Library/BaseMemoryLib.h>
28 // Define the maximum debug and assert message length that this library supports
30 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
35 Prints a debug message to the debug output device if the specified error level is enabled.
37 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
38 the message specified by Format and the associated variable argument list to
39 the debug output device.
41 If Format is NULL, then ASSERT().
43 @param ErrorLevel The error level of the debug message.
44 @param Format Format string for the debug message to print.
45 @param ... The variable argument list.
52 IN CONST CHAR8
*Format
,
56 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
57 CHAR8 AsciiBuffer
[MAX_DEBUG_MESSAGE_LENGTH
];
61 // If Format is NULL, then ASSERT().
63 ASSERT (Format
!= NULL
);
66 // Check driver debug mask value and global mask
68 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
73 // Convert the DEBUG() message to a Unicode String
75 VA_START (Marker
, Format
);
76 AsciiVSPrint (AsciiBuffer
, sizeof (AsciiBuffer
), Format
, Marker
);
77 AsciiStrToUnicodeStr (AsciiBuffer
, Buffer
);
82 // Send the print string to the Console Output device
84 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
85 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
92 Prints an assert message containing a filename, line number, and description.
93 This may be followed by a breakpoint or a dead loop.
95 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
96 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
97 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
98 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
99 CpuDeadLoop() is called. If neither of these bits are set, then this function
100 returns immediately after the message is printed to the debug output device.
101 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
102 processing another DebugAssert(), then DebugAssert() must return immediately.
104 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
106 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
108 @param FileName Pointer to the name of the source file that generated the assert condition.
109 @param LineNumber The line number in the source file that generated the assert condition
110 @param Description Pointer to the description of the assert condition.
116 IN CONST CHAR8
*FileName
,
118 IN CONST CHAR8
*Description
121 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
122 CHAR8 AsciiBuffer
[MAX_DEBUG_MESSAGE_LENGTH
];
125 // Generate the ASSERT() message in Unicode format
127 AsciiSPrint (AsciiBuffer
, sizeof (AsciiBuffer
), "ASSERT %a(%d): %a\n", FileName
, LineNumber
, Description
);
128 AsciiStrToUnicodeStr (AsciiBuffer
, Buffer
);
131 // Send the print string to the Console Output device
133 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
134 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
138 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
140 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
142 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
150 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
152 This function fills Length bytes of Buffer with the value specified by
153 PcdDebugClearMemoryValue, and returns Buffer.
155 If Buffer is NULL, then ASSERT().
157 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
159 @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
160 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
162 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
173 // If Buffer is NULL, then ASSERT().
175 ASSERT (Buffer
!= NULL
);
178 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
180 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
186 Returns TRUE if ASSERT() macros are enabled.
188 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
189 PcdDebugProperyMask is set. Otherwise FALSE is returned.
191 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
192 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
201 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
207 Returns TRUE if DEBUG()macros are enabled.
209 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
210 PcdDebugProperyMask is set. Otherwise FALSE is returned.
212 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
213 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
222 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
228 Returns TRUE if DEBUG_CODE()macros are enabled.
230 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
231 PcdDebugProperyMask is set. Otherwise FALSE is returned.
233 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
234 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
243 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
249 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
251 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
252 PcdDebugProperyMask is set. Otherwise FALSE is returned.
254 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
255 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
260 DebugClearMemoryEnabled (
264 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);