3 Copyright (c) 2008-2009, Apple Inc. All rights reserved.
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.
15 UEFI Debug Library that uses PrintLib to send messages to STDERR.
17 Copyright (c) 2006 - 2007, Intel Corporation<BR>
18 All rights reserved. This program and the accompanying materials
19 are licensed and made available under the terms and conditions of the BSD License
20 which accompanies this distribution. The full text of the license may be found at
21 http://opensource.org/licenses/bsd-license.php
23 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
24 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
30 #include <Library/DebugLib.h>
31 #include <Library/PrintLib.h>
32 #include <Library/PcdLib.h>
33 #include <Library/BaseLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/SemihostLib.h>
38 // Define the maximum debug and assert message length that this library supports
40 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
44 Prints a debug message to the debug output device if the specified error level is enabled.
46 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
47 the message specified by Format and the associated variable argument list to
48 the debug output device.
50 If Format is NULL, then ASSERT().
52 @param ErrorLevel The error level of the debug message.
53 @param Format Format string for the debug message to print.
60 IN CONST CHAR8
*Format
,
64 CHAR8 AsciiBuffer
[MAX_DEBUG_MESSAGE_LENGTH
];
68 // If Format is NULL, then ASSERT().
70 ASSERT (Format
!= NULL
);
73 // Check driver debug mask value and global mask
75 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
80 // Convert the DEBUG() message to a Unicode String
82 VA_START (Marker
, Format
);
83 AsciiVSPrint (AsciiBuffer
, sizeof (AsciiBuffer
), Format
, Marker
);
86 SemihostWriteString (AsciiBuffer
);
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 CHAR8 AsciiBuffer
[MAX_DEBUG_MESSAGE_LENGTH
];
124 // Generate the ASSERT() message in Unicode format
126 AsciiSPrint (AsciiBuffer
, sizeof (AsciiBuffer
), "ASSERT %a(%d): %a\n", FileName
, LineNumber
, Description
);
128 SemihostWriteString (AsciiBuffer
);
131 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
133 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
135 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
143 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
145 This function fills Length bytes of Buffer with the value specified by
146 PcdDebugClearMemoryValue, and returns Buffer.
148 If Buffer is NULL, then ASSERT().
150 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
152 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
153 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
166 // If Buffer is NULL, then ASSERT().
168 ASSERT (Buffer
!= NULL
);
171 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
173 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
179 Returns TRUE if ASSERT() macros are enabled.
181 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
182 PcdDebugProperyMask is set. Otherwise FALSE is returned.
184 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
185 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
194 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);
221 Returns TRUE if DEBUG_CODE()macros are enabled.
223 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
224 PcdDebugProperyMask is set. Otherwise FALSE is returned.
226 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
227 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
236 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
242 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
244 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
245 PcdDebugProperyMask is set. Otherwise FALSE is returned.
247 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
248 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
253 DebugClearMemoryEnabled (
257 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);