]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
Fix a typo.
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / PeiDxeDebugLibReportStatusCode / DebugLib.c
CommitLineData
2287f237 1/** @file\r
2 Debug Library that fowards all messages to ReportStatusCode()\r
3\r
4 Copyright (c) 2006, Intel Corporation<BR>\r
5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15\r
16\r
17#include <FrameworkPei.h>\r
551ed06f 18#include <FrameworkModuleBase.h>\r
2287f237 19#include <Guid/StatusCodeDataTypeId.h>\r
20\r
21#include <Library/DebugLib.h>\r
22#include <Library/BaseLib.h>\r
23#include <Library/BaseMemoryLib.h>\r
24#include <Library/ReportStatusCodeLib.h>\r
25#include <Library/PcdLib.h>\r
26\r
27#include <DebugInfo.h>\r
28\r
29/**\r
30\r
31 Prints a debug message to the debug output device if the specified error level is enabled.\r
32\r
33 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print\r
34 the message specified by Format and the associated variable argument list to\r
35 the debug output device.\r
36\r
37 If Format is NULL, then ASSERT().\r
38\r
39 @param ErrorLevel The error level of the debug message.\r
40 @param Format Format string for the debug message to print.\r
41\r
42**/\r
43VOID\r
44EFIAPI\r
45DebugPrint (\r
46 IN UINTN ErrorLevel,\r
47 IN CONST CHAR8 *Format,\r
48 ...\r
49 )\r
50{\r
51 UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)];\r
52 EFI_DEBUG_INFO *DebugInfo;\r
53 UINTN TotalSize;\r
54 UINTN Index;\r
55 VA_LIST Marker;\r
56 UINT64 *ArgumentPointer;\r
57\r
58 //\r
59 // If Format is NULL, then ASSERT().\r
60 //\r
61 ASSERT (Format != NULL);\r
62\r
63 //\r
64 // Check driver Debug Level value and global debug level\r
65 //\r
66 if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
67 return;\r
68 }\r
69\r
70 TotalSize = sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrLen (Format) + 1;\r
71 if (TotalSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
72 return;\r
73 }\r
74\r
75 //\r
76 // Then EFI_DEBUG_INFO\r
77 //\r
78 DebugInfo = (EFI_DEBUG_INFO *)Buffer;\r
79 DebugInfo->ErrorLevel = (UINT32)ErrorLevel;\r
80\r
81 //\r
82 // 256 byte mini Var Arg stack. That is followed by the format string.\r
83 //\r
84 VA_START (Marker, Format);\r
85 for (Index = 0, ArgumentPointer = (UINT64 *)(DebugInfo + 1); Index < 12; Index++, ArgumentPointer++) {\r
86 WriteUnaligned64(ArgumentPointer, VA_ARG (Marker, UINT64));\r
87 }\r
88 VA_END (Marker);\r
89 AsciiStrCpy ((CHAR8 *)ArgumentPointer, Format);\r
90\r
91 REPORT_STATUS_CODE_EX (\r
92 EFI_DEBUG_CODE,\r
93 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_DC_UNSPECIFIED),\r
94 0,\r
95 NULL,\r
96 &gEfiStatusCodeDataTypeDebugGuid,\r
97 DebugInfo,\r
98 TotalSize\r
99 );\r
100}\r
101\r
102\r
103/**\r
104\r
105 Prints an assert message containing a filename, line number, and description.\r
106 This may be followed by a breakpoint or a dead loop.\r
107\r
108 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
109 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of\r
110 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if\r
111 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then\r
112 CpuDeadLoop() is called. If neither of these bits are set, then this function\r
113 returns immediately after the message is printed to the debug output device.\r
114 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
115 processing another DebugAssert(), then DebugAssert() must return immediately.\r
116\r
117 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
118\r
119 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
120\r
121 @param FileName Pointer to the name of the source file that generated the assert condition.\r
122 @param LineNumber The line number in the source file that generated the assert condition\r
123 @param Description Pointer to the description of the assert condition.\r
124\r
125**/\r
126VOID\r
127EFIAPI\r
128DebugAssert (\r
129 IN CONST CHAR8 *FileName,\r
130 IN UINTN LineNumber,\r
131 IN CONST CHAR8 *Description\r
132 )\r
133{\r
134 UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];\r
135 EFI_DEBUG_ASSERT_DATA *AssertData;\r
136 UINTN TotalSize;\r
137 CHAR8 *Temp;\r
138 UINTN FileNameLength;\r
139 UINTN DescriptionLength;\r
140\r
141 //\r
142 // Make sure it will all fit in the passed in buffer\r
143 //\r
144 FileNameLength = AsciiStrLen (FileName);\r
145 DescriptionLength = AsciiStrLen (Description);\r
146 TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + FileNameLength + 1 + DescriptionLength + 1;\r
147 if (TotalSize <= EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
148 //\r
149 // Fill in EFI_DEBUG_ASSERT_DATA\r
150 //\r
151 AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
152 AssertData->LineNumber = (UINT32)LineNumber;\r
153\r
154 //\r
155 // Copy Ascii FileName including NULL.\r
156 //\r
157 Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);\r
158\r
159 //\r
160 // Copy Ascii Description\r
161 //\r
162 AsciiStrCpy (Temp + AsciiStrLen (FileName) + 1, Description);\r
163\r
164 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
165 (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
166 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
167 AssertData,\r
168 TotalSize\r
169 );\r
170 }\r
171\r
172 //\r
173 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
174 //\r
175 if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
176 CpuBreakpoint ();\r
177 } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
178 CpuDeadLoop ();\r
179 }\r
180}\r
181\r
182\r
183/**\r
184\r
185 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
186\r
187 This function fills Length bytes of Buffer with the value specified by\r
188 PcdDebugClearMemoryValue, and returns Buffer.\r
189\r
190 If Buffer is NULL, then ASSERT().\r
191\r
192 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().\r
193\r
194 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
195 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r
196\r
197 @return Buffer\r
198\r
199**/\r
200VOID *\r
201EFIAPI\r
202DebugClearMemory (\r
203 OUT VOID *Buffer,\r
204 IN UINTN Length\r
205 )\r
206{\r
207 //\r
208 // If Buffer is NULL, then ASSERT().\r
209 //\r
210 ASSERT (Buffer != NULL);\r
211\r
212 //\r
213 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
214 //\r
215 return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
216}\r
217\r
218\r
219/**\r
220\r
221 Returns TRUE if ASSERT() macros are enabled.\r
222\r
223 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r
224 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
225\r
226 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
227 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
228\r
229**/\r
230BOOLEAN\r
231EFIAPI\r
232DebugAssertEnabled (\r
233 VOID\r
234 )\r
235{\r
236 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
237}\r
238\r
239\r
240/**\r
241\r
242 Returns TRUE if DEBUG()macros are enabled.\r
243\r
244 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r
245 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
246\r
247 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
248 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
249\r
250**/\r
251BOOLEAN\r
252EFIAPI\r
253DebugPrintEnabled (\r
254 VOID\r
255 )\r
256{\r
257 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
258}\r
259\r
260\r
261/**\r
262\r
263 Returns TRUE if DEBUG_CODE()macros are enabled.\r
264\r
265 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r
266 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
267\r
268 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
269 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
270\r
271**/\r
272BOOLEAN\r
273EFIAPI\r
274DebugCodeEnabled (\r
275 VOID\r
276 )\r
277{\r
278 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
279}\r
280\r
281\r
282/**\r
283\r
284 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
285\r
286 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of\r
287 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
288\r
289 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
290 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
291\r
292**/\r
293BOOLEAN\r
294EFIAPI\r
295DebugClearMemoryEnabled (\r
296 VOID\r
297 )\r
298{\r
299 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
300}\r