8a4c6a2c1c55259f9bf1e8f8926520fd2ac485ef
[people/mcb30/edk2.git] / edk2 / MdePkg / Library / BaseDebugLibReportStatusCode / DebugLib.c
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 \r
18   Prints a debug message to the debug output device if the specified error level is enabled.\r
19 \r
20   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
21   the message specified by Format and the associated variable argument list to \r
22   the debug output device.\r
23 \r
24   If Format is NULL, then ASSERT().\r
25 \r
26   @param  ErrorLevel  The error level of the debug message.\r
27   @param  Format      Format string for the debug message to print.\r
28 \r
29 **/\r
30 VOID\r
31 EFIAPI\r
32 DebugPrint (\r
33   IN  UINTN ErrorLevel,\r
34   IN  CHAR8 *Format,\r
35   ...\r
36   )\r
37 {\r
38   UINT64          Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)];\r
39   EFI_DEBUG_INFO  *DebugInfo;\r
40   UINTN           TotalSize;\r
41   UINTN           Index;\r
42   VA_LIST         Marker;\r
43   UINT64          *ArgumentPointer;\r
44 \r
45   //\r
46   // If Format is NULL, then ASSERT().\r
47   //\r
48   ASSERT (Format != NULL);\r
49 \r
50   //\r
51   // Check driver Debug Level value and global debug level\r
52   //\r
53   if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
54     return;\r
55   }\r
56 \r
57   TotalSize = sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrLen (Format) + 1;\r
58   if (TotalSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
59     return;\r
60   }\r
61 \r
62   //\r
63   // Then EFI_DEBUG_INFO\r
64   //\r
65   DebugInfo = (EFI_DEBUG_INFO *)Buffer;\r
66   DebugInfo->ErrorLevel = (UINT32)ErrorLevel;\r
67 \r
68   //\r
69   // 256 byte mini Var Arg stack. That is followed by the format string.\r
70   //\r
71   VA_START (Marker, Format);\r
72   for (Index = 0, ArgumentPointer = (UINT64 *)(DebugInfo + 1); Index < 12; Index++, ArgumentPointer++) {\r
73     *ArgumentPointer = VA_ARG (Marker, UINT64);\r
74   }\r
75   VA_END (Marker);\r
76   AsciiStrCpy ((CHAR8 *)ArgumentPointer, Format);\r
77 \r
78   //\r
79   //\r
80   //\r
81   REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
82     EFI_DEBUG_CODE,\r
83     (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_DC_UNSPECIFIED),\r
84     DebugInfo,\r
85     TotalSize\r
86     );\r
87 }\r
88 \r
89 \r
90 /**\r
91 \r
92   Prints an assert message containing a filename, line number, and description.  \r
93   This may be followed by a breakpoint or a dead loop.\r
94 \r
95   Print a message of the form \93ASSERT <FileName>(<LineNumber>): <Description>\n\94 \r
96   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
97   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
98   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
99   CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
100   returns immediately after the message is printed to the debug output device.\r
101   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while\r
102   processing another DebugAssert(), then DebugAssert() must return immediately.\r
103 \r
104   If FileName is NULL, then a <FileName> string of \93(NULL) Filename\94 is printed.\r
105 \r
106   If Description is NULL, then a <Description> string of \93(NULL) Description\94 is printed.\r
107 \r
108   @param  FileName     Pointer to the name of the source file that generated the assert condition.\r
109   @param  LineNumber   The line number in the source file that generated the assert condition\r
110   @param  Description  Pointer to the description of the assert condition.\r
111 \r
112 **/\r
113 VOID\r
114 EFIAPI\r
115 DebugAssert (\r
116   IN CHAR8  *FileName,\r
117   IN INTN   LineNumber,\r
118   IN CHAR8  *Description\r
119   )\r
120 {\r
121   UINT64                 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];\r
122   EFI_DEBUG_ASSERT_DATA  *AssertData;\r
123   UINTN                  TotalSize;\r
124   CHAR8                  *Temp;\r
125 \r
126   //\r
127   // Make sure it will all fit in the passed in buffer\r
128   //\r
129   TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + AsciiStrLen (FileName) + 1 + AsciiStrLen (Description) + 1;\r
130   if (TotalSize <= EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
131     //\r
132     // Fill in EFI_DEBUG_ASSERT_DATA\r
133     //\r
134     AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
135     AssertData->LineNumber = (UINT32)LineNumber;\r
136 \r
137     //\r
138     // Copy Ascii FileName including NULL.\r
139     //\r
140     Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);\r
141 \r
142     //\r
143     // Copy Ascii Description \r
144     //\r
145     AsciiStrCpy (Temp + AsciiStrLen(FileName) + 1, Description);\r
146 \r
147     REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
148       (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
149       (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
150       AssertData,\r
151       TotalSize\r
152       );\r
153   }\r
154 \r
155   //\r
156   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
157   //\r
158   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
159     CpuBreakpoint ();\r
160   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
161     CpuDeadLoop ();\r
162   }\r
163 }\r
164 \r
165 \r
166 /**\r
167 \r
168   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
169 \r
170   This function fills Length bytes of Buffer with the value specified by \r
171   PcdDebugClearMemoryValue, and returns Buffer.\r
172 \r
173   If Buffer is NULL, then ASSERT().\r
174 \r
175   If Length is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT(). \r
176 \r
177   @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
178   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
179 \r
180   @return  Buffer\r
181 \r
182 **/\r
183 VOID *\r
184 EFIAPI\r
185 DebugClearMemory (\r
186   OUT VOID  *Buffer,\r
187   IN UINTN  Length\r
188   )\r
189 {\r
190   //\r
191   // If Buffer is NULL, then ASSERT().\r
192   //\r
193   ASSERT (Buffer != NULL);\r
194 \r
195   //\r
196   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
197   //\r
198   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
199 }\r
200 \r
201 \r
202 /**\r
203   \r
204   Returns TRUE if ASSERT() macros are enabled.\r
205 \r
206   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
207   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
208 \r
209   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
210   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
211 \r
212 **/\r
213 BOOLEAN\r
214 EFIAPI\r
215 DebugAssertEnabled (\r
216   VOID\r
217   )\r
218 {\r
219   return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
220 }\r
221 \r
222 \r
223 /**\r
224   \r
225   Returns TRUE if DEBUG()macros are enabled.\r
226 \r
227   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
228   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
229 \r
230   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
231   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
232 \r
233 **/\r
234 BOOLEAN\r
235 EFIAPI\r
236 DebugPrintEnabled (\r
237   VOID\r
238   )\r
239 {\r
240   return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
241 }\r
242 \r
243 \r
244 /**\r
245   \r
246   Returns TRUE if DEBUG_CODE()macros are enabled.\r
247 \r
248   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
249   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
250 \r
251   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
252   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
253 \r
254 **/\r
255 BOOLEAN\r
256 EFIAPI\r
257 DebugCodeEnabled (\r
258   VOID\r
259   )\r
260 {\r
261   return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
262 }\r
263 \r
264 \r
265 /**\r
266   \r
267   Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
268 \r
269   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
270   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
271 \r
272   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
273   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
274 \r
275 **/\r
276 BOOLEAN\r
277 EFIAPI\r
278 DebugClearMemoryEnabled (\r
279   VOID\r
280   )\r
281 {\r
282   return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
283 }\r