2 Debug Library that fowards all messages to ReportStatusCode()
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.
17 #include <FrameworkPei.h>
18 #include <FrameworkModuleBase.h>
19 #include <Guid/StatusCodeDataTypeId.h>
20 #include <Guid/StatusCodeDataTypeDebug.h>
22 #include <Library/DebugLib.h>
23 #include <Library/BaseLib.h>
24 #include <Library/BaseMemoryLib.h>
25 #include <Library/ReportStatusCodeLib.h>
26 #include <Library/PcdLib.h>
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 UINT64 Buffer
[(EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof (UINT64
)) + 1];
53 EFI_DEBUG_INFO
*DebugInfo
;
56 BASE_LIST BaseListMarker
;
62 // If Format is NULL, then ASSERT().
64 ASSERT (Format
!= NULL
);
67 // Check driver Debug Level value and global debug level
69 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
74 // Compute the total size of the record
76 TotalSize
= sizeof (EFI_DEBUG_INFO
) + 12 * sizeof (UINT64
) + AsciiStrLen (Format
) + 1;
79 // If the TotalSize is larger than the maximum record size, then return
81 if (TotalSize
> sizeof (Buffer
)) {
86 // Fill in EFI_DEBUG_INFO
88 DebugInfo
= (EFI_DEBUG_INFO
*)(Buffer
) + 1;
89 DebugInfo
->ErrorLevel
= (UINT32
)ErrorLevel
;
90 BaseListMarker
= (BASE_LIST
)(DebugInfo
+ 1);
91 FormatString
= (CHAR8
*)((UINT64
*)(DebugInfo
+ 1) + 12);
94 // Copy the Format string into the record
96 AsciiStrCpy (FormatString
, Format
);
99 // 256 byte mini Var Arg stack. That is followed by the format string.
101 VA_START (VaListMarker
, Format
);
102 for (; *Format
!= '\0'; Format
++) {
103 if (*Format
!= '%') {
108 // Parse Flags and Width
110 for (Done
= FALSE
; !Done
; ) {
134 BASE_ARG (BaseListMarker
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
138 // Make no output if Format string terminates unexpectedly when
139 // looking up for flag, width, precision and type.
143 // break skipped on purpose.
152 // Handle each argument type
156 if (sizeof (VOID
*) > 4) {
163 BASE_ARG (BaseListMarker
, INT64
) = VA_ARG (VaListMarker
, INT64
);
165 BASE_ARG (BaseListMarker
, int) = VA_ARG (VaListMarker
, int);
173 BASE_ARG (BaseListMarker
, VOID
*) = VA_ARG (VaListMarker
, VOID
*);
176 BASE_ARG (BaseListMarker
, UINTN
) = VA_ARG (VaListMarker
, UINTN
);
179 BASE_ARG (BaseListMarker
, RETURN_STATUS
) = VA_ARG (VaListMarker
, RETURN_STATUS
);
184 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then ASSERT()
185 // This indicates that the DEBUG() macro is passing in more argument than can be handled by
186 // the EFI_DEBUG_INFO record
188 ASSERT ((CHAR8
*)BaseListMarker
<= FormatString
);
191 // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return
193 if ((CHAR8
*)BaseListMarker
> FormatString
) {
197 VA_END (VaListMarker
);
200 // Send the DebugInfo record
202 REPORT_STATUS_CODE_EX (
204 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_DC_UNSPECIFIED
),
207 &gEfiStatusCodeDataTypeDebugGuid
,
215 Prints an assert message containing a filename, line number, and description.
216 This may be followed by a breakpoint or a dead loop.
218 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
219 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
220 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
221 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
222 CpuDeadLoop() is called. If neither of these bits are set, then this function
223 returns immediately after the message is printed to the debug output device.
224 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
225 processing another DebugAssert(), then DebugAssert() must return immediately.
227 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
229 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
231 @param FileName Pointer to the name of the source file that generated the assert condition.
232 @param LineNumber The line number in the source file that generated the assert condition
233 @param Description Pointer to the description of the assert condition.
239 IN CONST CHAR8
*FileName
,
241 IN CONST CHAR8
*Description
244 UINT64 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
/ sizeof(UINT64
)];
245 EFI_DEBUG_ASSERT_DATA
*AssertData
;
248 UINTN FileNameLength
;
249 UINTN DescriptionLength
;
252 // Make sure it will all fit in the passed in buffer
254 FileNameLength
= AsciiStrLen (FileName
);
255 DescriptionLength
= AsciiStrLen (Description
);
256 TotalSize
= sizeof (EFI_DEBUG_ASSERT_DATA
) + FileNameLength
+ 1 + DescriptionLength
+ 1;
257 if (TotalSize
<= sizeof (Buffer
)) {
259 // Fill in EFI_DEBUG_ASSERT_DATA
261 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)Buffer
;
262 AssertData
->LineNumber
= (UINT32
)LineNumber
;
265 // Copy Ascii FileName including NULL.
267 Temp
= AsciiStrCpy ((CHAR8
*)(AssertData
+ 1), FileName
);
270 // Copy Ascii Description
272 AsciiStrCpy (Temp
+ AsciiStrLen (FileName
) + 1, Description
);
274 REPORT_STATUS_CODE_EX (
275 (EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
),
276 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
),
286 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
288 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
290 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
298 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
300 This function fills Length bytes of Buffer with the value specified by
301 PcdDebugClearMemoryValue, and returns Buffer.
303 If Buffer is NULL, then ASSERT().
305 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
307 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
308 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
321 // If Buffer is NULL, then ASSERT().
323 ASSERT (Buffer
!= NULL
);
326 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
328 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
334 Returns TRUE if ASSERT() macros are enabled.
336 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
337 PcdDebugProperyMask is set. Otherwise FALSE is returned.
339 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
340 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
349 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
355 Returns TRUE if DEBUG()macros are enabled.
357 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
358 PcdDebugProperyMask is set. Otherwise FALSE is returned.
360 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
361 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
370 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
376 Returns TRUE if DEBUG_CODE()macros are enabled.
378 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
379 PcdDebugProperyMask is set. Otherwise FALSE is returned.
381 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
382 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
391 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
397 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
399 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
400 PcdDebugProperyMask is set. Otherwise FALSE is returned.
402 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
403 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
408 DebugClearMemoryEnabled (
412 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);