4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Define the maximum debug and assert message length that this library supports
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Prints a debug message to the debug output device if the specified error level is enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetDebugPrintErrorLevel (), then print the message specified by Format and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated variable argument list to the debug output device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Format is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ErrorLevel The error level of the debug message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Format The format string for the debug message to print.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... The variable argument list whose contents are accessed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync based on the format string specified by Format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Format is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check driver debug mask value and global mask
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Convert the DEBUG() message to a Unicode String
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send the print string to the Standard Error device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Prints an assert message containing a filename, line number, and description.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This may be followed by a breakpoint or a dead loop.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CpuDeadLoop() is called. If neither of these bits are set, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns immediately after the message is printed to the debug output device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugAssert() must actively prevent recursion. If DebugAssert() is called while
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync processing another DebugAssert(), then DebugAssert() must return immediately.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName The pointer to the name of the source file that generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the assert condition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LineNumber The line number in the source file that generated the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync assert condition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Description The pointer to the description of the assert condition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Generate the ASSERT() message in Unicode format
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "ASSERT %a(%d): %a\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send the print string to the Standard Error device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function fills Length bytes of Buffer with the value specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugClearMemoryValue, and returns Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if ASSERT() macros are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugProperyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if DEBUG() macros are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugProperyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if DEBUG_CODE() macros are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugProperyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdDebugProperyMask is set. Otherwise FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.