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.
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>
25 // Define the maximum debug and assert message length that this library supports
27 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
30 Prints a debug message to the debug output device if the specified error level is enabled.
32 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
33 the message specified by Format and the associated variable argument list to
34 the debug output device.
36 If Format is NULL, then ASSERT().
38 @param ErrorLevel The error level of the debug message.
39 @param Format Format string for the debug message to print.
40 @param ... Variable argument list whose contents are accessed
41 based on the format string specified by Format.
48 IN CONST CHAR8
*Format
,
52 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
56 // If Format is NULL, then ASSERT().
58 ASSERT (Format
!= NULL
);
61 // Check driver debug mask value and global mask
63 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
68 // Convert the DEBUG() message to a Unicode String
70 VA_START (Marker
, Format
);
71 UnicodeVSPrintAsciiFormat (Buffer
, MAX_DEBUG_MESSAGE_LENGTH
, Format
, Marker
);
76 // Send the print string to the Console Output device
78 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
79 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
85 Prints an assert message containing a filename, line number, and description.
86 This may be followed by a breakpoint or a dead loop.
88 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
89 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
90 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
91 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
92 CpuDeadLoop() is called. If neither of these bits are set, then this function
93 returns immediately after the message is printed to the debug output device.
94 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
95 processing another DebugAssert(), then DebugAssert() must return immediately.
97 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
98 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
100 @param FileName Pointer to the name of the source file that generated the assert condition.
101 @param LineNumber The line number in the source file that generated the assert condition
102 @param Description Pointer to the description of the assert condition.
108 IN CONST CHAR8
*FileName
,
110 IN CONST CHAR8
*Description
113 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
116 // Generate the ASSERT() message in Unicode format
118 UnicodeSPrintAsciiFormat (
120 MAX_DEBUG_MESSAGE_LENGTH
,
121 "ASSERT %a(%d): %a\n",
128 // Send the print string to the Console Output device
130 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
131 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
135 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
137 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
139 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
146 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
148 This function fills Length bytes of Buffer with the value specified by
149 PcdDebugClearMemoryValue, and returns Buffer.
151 If Buffer is NULL, then ASSERT().
152 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
154 @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
155 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
157 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
168 // If Buffer is NULL, then ASSERT().
170 ASSERT (Buffer
!= NULL
);
173 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
175 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
180 Returns TRUE if ASSERT() macros are enabled.
182 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
183 PcdDebugProperyMask is set. Otherwise FALSE is returned.
185 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
186 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
195 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
200 Returns TRUE if DEBUG() macros are enabled.
202 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
203 PcdDebugProperyMask is set. Otherwise FALSE is returned.
205 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
206 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
215 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
220 Returns TRUE if DEBUG_CODE() macros are enabled.
222 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
223 PcdDebugProperyMask is set. Otherwise FALSE is returned.
225 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
226 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
235 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
240 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
242 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
243 PcdDebugProperyMask is set. Otherwise FALSE is returned.
245 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
246 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
251 DebugClearMemoryEnabled (
255 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);