2 UEFI Debug Library that uses PrintLib to send messages to CONOUT.
4 Copyright (c) 2006, 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.
16 // Define the maximum debug and assert message length that this library supports.
18 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
20 STATIC BOOLEAN mDebugLevelInstalled
= FALSE
;
21 STATIC EFI_DEBUG_LEVEL_PROTOCOL mDebugLevel
= { 0 };
24 Installs Debug Level Protocol.
26 The constructor function installs Debug Level Protocol on the ImageHandle.
27 It will ASSERT() if the installation fails and will always return EFI_SUCCESS.
29 @param ImageHandle The firmware allocated handle for the EFI image.
30 @param SystemTable A pointer to the EFI System Table.
32 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
38 IN EFI_HANDLE ImageHandle
,
39 IN EFI_SYSTEM_TABLE
*SystemTable
45 // Initialize Debug Level Protocol.
47 mDebugLevel
.DebugLevel
= PcdGet32(PcdDebugPrintErrorLevel
);
50 // Install Debug Level Protocol.
52 Status
= gBS
->InstallMultipleProtocolInterfaces (
54 &gEfiDebugLevelProtocolGuid
,
58 ASSERT_EFI_ERROR (Status
);
61 // Set flag to show that the Debug Level Protocol has been installed.
63 mDebugLevelInstalled
= TRUE
;
70 Prints a debug message to the debug output device if the specified error level is enabled.
72 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
73 the message specified by Format and the associated variable argument list to
74 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.
86 IN CONST CHAR8
*Format
,
90 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
94 // If Format is NULL, then ASSERT().
96 ASSERT (Format
!= NULL
);
99 // Check driver Debug Level value and global debug level
101 if (mDebugLevelInstalled
) {
102 if ((ErrorLevel
& mDebugLevel
.DebugLevel
) == 0) {
106 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
112 // Convert the DEBUG() message to a Unicode String
114 VA_START (Marker
, Format
);
115 UnicodeVSPrintAsciiFormat (Buffer
, sizeof (Buffer
), Format
, Marker
);
119 // Send the print string to the Console Output device if CONOUT is available.
121 if (gST
->ConOut
!= NULL
) {
122 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
129 Prints an assert message containing a filename, line number, and description.
130 This may be followed by a breakpoint or a dead loop.
132 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
133 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
134 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
135 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
136 CpuDeadLoop() is called. If neither of these bits are set, then this function
137 returns immediately after the message is printed to the debug output device.
138 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
139 processing another DebugAssert(), then DebugAssert() must return immediately.
141 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
143 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
145 @param FileName Pointer to the name of the source file that generated the assert condition.
146 @param LineNumber The line number in the source file that generated the assert condition
147 @param Description Pointer to the description of the assert condition.
153 IN CONST CHAR8
*FileName
,
155 IN CONST CHAR8
*Description
158 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
161 // Generate the ASSERT() message in Unicode format
163 UnicodeSPrintAsciiFormat (Buffer
, sizeof (Buffer
), "ASSERT %s(%d): %s\n", FileName
, LineNumber
, Description
);
166 // Send the print string to the Console Output device if CONOUT is available.
168 if (gST
->ConOut
!= NULL
) {
169 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
173 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
175 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
177 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
185 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
187 This function fills Length bytes of Buffer with the value specified by
188 PcdDebugClearMemoryValue, and returns Buffer.
190 If Buffer is NULL, then ASSERT().
192 If Length is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT().
194 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
195 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
208 // If Buffer is NULL, then ASSERT().
210 ASSERT (Buffer
!= NULL
);
213 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
215 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
221 Returns TRUE if ASSERT() macros are enabled.
223 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
224 PcdDebugProperyMask is set. Otherwise FALSE is returned.
226 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
227 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
236 return ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
242 Returns TRUE if DEBUG()macros are enabled.
244 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
245 PcdDebugProperyMask is set. Otherwise FALSE is returned.
247 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
248 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
257 return ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
263 Returns TRUE if DEBUG_CODE()macros are enabled.
265 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
266 PcdDebugProperyMask is set. Otherwise FALSE is returned.
268 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
269 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
278 return ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
284 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
286 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
287 PcdDebugProperyMask is set. Otherwise FALSE is returned.
289 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
290 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
295 DebugClearMemoryEnabled (
299 return ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);