]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | Report Status Code Library for DXE Phase.\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 | // Define the maximum extended data size that is supported in the PEI phase\r | |
17 | //\r | |
18 | #define MAX_EXTENDED_DATA_SIZE 0x200\r | |
19 | \r | |
20 | /**\r | |
21 | Internal worker function that reports a status code through the Status Code Protocol\r | |
22 | \r | |
23 | This function checks to see if a Status Code Protocol is present in the handle \r | |
24 | database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is \r | |
25 | returned. If a Status Code Protocol is present, then it is cached in gStatusCode,\r | |
26 | and the ReportStatusCode() service of the Status Code Protocol is called passing in\r | |
27 | Type, Value, Instance, CallerId, and Data. The result of this call is returned.\r | |
28 | \r | |
29 | @param Type Status code type. \r | |
30 | @param Value Status code value.\r | |
31 | @param Instance Status code instance number.\r | |
32 | @param CallerId Pointer to a GUID that identifies the caller of this \r | |
33 | function. This is an optional parameter that may be \r | |
34 | NULL.\r | |
35 | @param Data Pointer to the extended data buffer. This is an \r | |
36 | optional parameter that may be NULL.\r | |
37 | \r | |
38 | @retval EFI_SUCCESS The status code was reported.\r | |
39 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.\r | |
40 | @retval EFI_UNSUPPORTED Status Code Protocol is not available.\r | |
41 | \r | |
42 | **/\r | |
43 | EFI_STATUS\r | |
44 | InternalReportStatusCode (\r | |
45 | IN EFI_STATUS_CODE_TYPE Type,\r | |
46 | IN EFI_STATUS_CODE_VALUE Value,\r | |
47 | IN UINT32 Instance,\r | |
8960cdeb | 48 | IN CONST EFI_GUID *CallerId OPTIONAL,\r |
878ddf1f | 49 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL \r |
50 | )\r | |
51 | {\r | |
52 | EFI_PEI_SERVICES **PeiServices;\r | |
53 | \r | |
54 | PeiServices = GetPeiServicesTablePointer ();\r | |
8960cdeb | 55 | return (*PeiServices)->PeiReportStatusCode (\r |
56 | PeiServices,\r | |
57 | Type,\r | |
58 | Value,\r | |
59 | Instance,\r | |
60 | (EFI_GUID *)CallerId,\r | |
61 | Data\r | |
62 | );\r | |
878ddf1f | 63 | }\r |
64 | \r | |
65 | \r | |
66 | /**\r | |
67 | Converts a status code to an 8-bit POST code value.\r | |
68 | \r | |
69 | Converts the status code specified by CodeType and Value to an 8-bit POST code \r | |
70 | and returns the 8-bit POST code in PostCode. If CodeType is an \r | |
71 | EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode \r | |
72 | are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits \r | |
73 | 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned. \r | |
74 | \r | |
75 | If PostCode is NULL, then ASSERT().\r | |
76 | \r | |
77 | @param CodeType The type of status code being converted.\r | |
78 | @param Value The status code value being converted.\r | |
79 | @param PostCode A pointer to the 8-bit POST code value to return. \r | |
80 | \r | |
81 | @retval TRUE The status code specified by CodeType and Value was converted \r | |
82 | to an 8-bit POST code and returned in PostCode.\r | |
83 | @retval FALSE The status code specified by CodeType and Value could not be \r | |
84 | converted to an 8-bit POST code value.\r | |
85 | \r | |
86 | **/\r | |
87 | BOOLEAN\r | |
88 | EFIAPI\r | |
89 | CodeTypeToPostCode (\r | |
90 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
91 | IN EFI_STATUS_CODE_VALUE Value,\r | |
92 | OUT UINT8 *PostCode\r | |
93 | )\r | |
94 | {\r | |
95 | //\r | |
96 | // If PostCode is NULL, then ASSERT()\r | |
97 | //\r | |
98 | ASSERT (PostCode != NULL);\r | |
99 | \r | |
100 | //\r | |
101 | // Convert Value to an 8 bit post code\r | |
102 | //\r | |
103 | if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r | |
104 | ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ) {\r | |
105 | *PostCode = (UINT8) (((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5);\r | |
106 | *PostCode |= (UINT8) (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f);\r | |
107 | return TRUE;\r | |
108 | }\r | |
109 | return FALSE;\r | |
110 | }\r | |
111 | \r | |
112 | \r | |
113 | /**\r | |
114 | Extracts ASSERT() information from a status code structure.\r | |
115 | \r | |
116 | Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r | |
117 | arguments specified by Filename, Description, and LineNumber. If CodeType is \r | |
118 | an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and \r | |
119 | Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract \r | |
120 | Filename, Description, and LineNumber from the optional data area of the \r | |
121 | status code buffer specified by Data. The optional data area of Data contains \r | |
122 | a Null-terminated ASCII string for the FileName, followed by a Null-terminated \r | |
123 | ASCII string for the Description, followed by a 32-bit LineNumber. If the \r | |
124 | ASSERT() information could be extracted from Data, then return TRUE. \r | |
125 | Otherwise, FALSE is returned. \r | |
126 | \r | |
127 | If Data is NULL, then ASSERT().\r | |
128 | If Filename is NULL, then ASSERT().\r | |
129 | If Description is NULL, then ASSERT().\r | |
130 | If LineNumber is NULL, then ASSERT().\r | |
131 | \r | |
132 | @param CodeType The type of status code being converted.\r | |
133 | @param Value The status code value being converted.\r | |
134 | @param Data Pointer to status code data buffer. \r | |
135 | @param Filename Pointer to the source file name that generated the ASSERT().\r | |
136 | @param Description Pointer to the description of the ASSERT().\r | |
137 | @param LineNumber Pointer to source line number that generated the ASSERT().\r | |
138 | \r | |
139 | @retval TRUE The status code specified by CodeType, Value, and Data was \r | |
140 | converted ASSERT() arguments specified by Filename, Description, \r | |
141 | and LineNumber.\r | |
142 | @retval FALSE The status code specified by CodeType, Value, and Data could \r | |
143 | not be converted to ASSERT() arguments.\r | |
144 | \r | |
145 | **/\r | |
146 | BOOLEAN\r | |
147 | EFIAPI\r | |
148 | ReportStatusCodeExtractAssertInfo (\r | |
8960cdeb | 149 | IN EFI_STATUS_CODE_TYPE CodeType,\r |
150 | IN EFI_STATUS_CODE_VALUE Value, \r | |
151 | IN CONST EFI_STATUS_CODE_DATA *Data, \r | |
152 | OUT CHAR8 **Filename,\r | |
153 | OUT CHAR8 **Description,\r | |
154 | OUT UINT32 *LineNumber\r | |
878ddf1f | 155 | )\r |
156 | {\r | |
157 | EFI_DEBUG_ASSERT_DATA *AssertData;\r | |
158 | \r | |
159 | ASSERT (Data != NULL);\r | |
160 | ASSERT (Filename != NULL);\r | |
161 | ASSERT (Description != NULL);\r | |
162 | ASSERT (LineNumber != NULL);\r | |
163 | \r | |
164 | if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) && \r | |
165 | ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&\r | |
166 | ((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {\r | |
167 | AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);\r | |
168 | *Filename = (CHAR8 *)(AssertData + 1);\r | |
169 | *Description = *Filename + AsciiStrLen (*Filename) + 1;\r | |
170 | *LineNumber = AssertData->LineNumber;\r | |
171 | return TRUE;\r | |
172 | }\r | |
173 | return FALSE;\r | |
174 | }\r | |
175 | \r | |
176 | \r | |
177 | /**\r | |
178 | Extracts DEBUG() information from a status code structure.\r | |
179 | \r | |
180 | Converts the status code specified by Data to the DEBUG() arguments specified \r | |
181 | by ErrorLevel, Marker, and Format. If type GUID in Data is \r | |
182 | EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and \r | |
183 | Format from the optional data area of the status code buffer specified by Data. \r | |
184 | The optional data area of Data contains a 32-bit ErrorLevel followed by Marker \r | |
185 | which is 12 UINTN parameters, followed by a Null-terminated ASCII string for \r | |
186 | the Format. If the DEBUG() information could be extracted from Data, then \r | |
187 | return TRUE. Otherwise, FALSE is returned.\r | |
188 | \r | |
189 | If Data is NULL, then ASSERT().\r | |
190 | If ErrorLevel is NULL, then ASSERT().\r | |
191 | If Marker is NULL, then ASSERT().\r | |
192 | If Format is NULL, then ASSERT().\r | |
193 | \r | |
194 | @param Data Pointer to status code data buffer. \r | |
195 | @param ErrorLevel Pointer to error level mask for a debug message.\r | |
196 | @param Marker Pointer to the variable argument list associated with Format.\r | |
197 | @param Format Pointer to a Null-terminated ASCII format string of a \r | |
198 | debug message.\r | |
199 | \r | |
200 | @retval TRUE The status code specified by Data was converted DEBUG() arguments \r | |
201 | specified by ErrorLevel, Marker, and Format.\r | |
202 | @retval FALSE The status code specified by Data could not be converted to \r | |
203 | DEBUG() arguments.\r | |
204 | \r | |
205 | **/\r | |
206 | BOOLEAN\r | |
207 | EFIAPI\r | |
208 | ReportStatusCodeExtractDebugInfo (\r | |
8960cdeb | 209 | IN CONST EFI_STATUS_CODE_DATA *Data, \r |
210 | OUT UINT32 *ErrorLevel,\r | |
211 | OUT VA_LIST *Marker,\r | |
212 | OUT CHAR8 **Format\r | |
878ddf1f | 213 | )\r |
214 | {\r | |
215 | EFI_DEBUG_INFO *DebugInfo;\r | |
216 | \r | |
217 | ASSERT (Data != NULL);\r | |
218 | ASSERT (ErrorLevel != NULL);\r | |
219 | ASSERT (Marker != NULL);\r | |
220 | ASSERT (Format != NULL);\r | |
221 | \r | |
222 | //\r | |
223 | // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE\r | |
224 | //\r | |
225 | if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {\r | |
226 | return FALSE;\r | |
227 | }\r | |
228 | \r | |
229 | //\r | |
230 | // Retrieve the debug information from the status code record\r | |
231 | //\r | |
232 | DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);\r | |
233 | \r | |
234 | *ErrorLevel = DebugInfo->ErrorLevel;\r | |
235 | \r | |
236 | //\r | |
237 | // The first 12 * UINTN bytes of the string are really an \r | |
238 | // argument stack to support varargs on the Format string.\r | |
239 | //\r | |
240 | *Marker = (VA_LIST) (DebugInfo + 1);\r | |
241 | *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);\r | |
242 | \r | |
243 | return TRUE;\r | |
244 | }\r | |
245 | \r | |
246 | \r | |
247 | /**\r | |
248 | Reports a status code.\r | |
249 | \r | |
250 | Reports the status code specified by the parameters Type and Value. Status \r | |
251 | code also require an instance, caller ID, and extended data. This function \r | |
252 | passed in a zero instance, NULL extended data, and a caller ID of \r | |
253 | gEfiCallerIdGuid, which is the GUID for the module. \r | |
254 | \r | |
255 | ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode() \r | |
256 | is called while processing another any other Report Status Code Library function,\r | |
257 | then ReportStatusCode() must return immediately.\r | |
258 | \r | |
259 | @param Type Status code type. \r | |
260 | @param Value Status code value.\r | |
261 | \r | |
262 | @retval EFI_SUCCESS The status code was reported.\r | |
263 | @retval EFI_DEVICE_ERROR There status code could not be reported due to a \r | |
264 | device error.\r | |
265 | @retval EFI_UNSUPPORTED Report status code is not supported\r | |
266 | \r | |
267 | **/\r | |
268 | EFI_STATUS\r | |
269 | EFIAPI\r | |
270 | ReportStatusCode (\r | |
271 | IN EFI_STATUS_CODE_TYPE Type,\r | |
272 | IN EFI_STATUS_CODE_VALUE Value\r | |
273 | )\r | |
274 | {\r | |
275 | return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);\r | |
276 | }\r | |
277 | \r | |
278 | \r | |
279 | /**\r | |
280 | Reports a status code with a Device Path Protocol as the extended data.\r | |
281 | \r | |
282 | Allocates and fills in the extended data section of a status code with the \r | |
283 | Device Path Protocol specified by DevicePath. This function is responsible \r | |
284 | for allocating a buffer large enough for the standard header and the device \r | |
285 | path. The standard header is filled in with a GUID of \r | |
286 | gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero \r | |
287 | instance and a caller ID of gEfiCallerIdGuid.\r | |
288 | \r | |
289 | ReportStatusCodeWithDevicePath()must actively prevent recursion. If \r | |
290 | ReportStatusCodeWithDevicePath() is called while processing another any other \r | |
291 | Report Status Code Library function, then ReportStatusCodeWithDevicePath() \r | |
292 | must return EFI_DEVICE_ERROR immediately.\r | |
293 | \r | |
294 | If DevicePath is NULL, then ASSERT().\r | |
295 | \r | |
296 | @param Type Status code type. \r | |
297 | @param Value Status code value.\r | |
298 | @param DevicePath Pointer to the Device Path Protocol to be reported.\r | |
299 | \r | |
300 | @retval EFI_SUCCESS The status code was reported with the extended \r | |
301 | data specified by DevicePath.\r | |
302 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r | |
303 | extended data section.\r | |
304 | @retval EFI_UNSUPPORTED Report status code is not supported\r | |
305 | \r | |
306 | **/\r | |
307 | EFI_STATUS\r | |
308 | EFIAPI\r | |
309 | ReportStatusCodeWithDevicePath (\r | |
8960cdeb | 310 | IN EFI_STATUS_CODE_TYPE Type,\r |
311 | IN EFI_STATUS_CODE_VALUE Value,\r | |
312 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
878ddf1f | 313 | )\r |
314 | {\r | |
315 | ASSERT (DevicePath != NULL);\r | |
8960cdeb | 316 | return EFI_UNSUPPORTED;\r |
878ddf1f | 317 | }\r |
318 | \r | |
319 | \r | |
320 | /**\r | |
321 | Reports a status code with an extended data buffer.\r | |
322 | \r | |
323 | Allocates and fills in the extended data section of a status code with the \r | |
324 | extended data specified by ExtendedData and ExtendedDataSize. ExtendedData \r | |
325 | is assumed to be one of the data structures specified in Related Definitions. \r | |
326 | These data structure do not have the standard header, so this function is \r | |
327 | responsible for allocating a buffer large enough for the standard header and \r | |
328 | the extended data passed into this function. The standard header is filled \r | |
329 | in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported \r | |
330 | with a zero instance and a caller ID of gEfiCallerIdGuid.\r | |
331 | \r | |
332 | ReportStatusCodeWithExtendedData()must actively prevent recursion. If \r | |
333 | ReportStatusCodeWithExtendedData() is called while processing another any other \r | |
334 | Report Status Code Library function, then ReportStatusCodeWithExtendedData() \r | |
335 | must return EFI_DEVICE_ERROR immediately.\r | |
336 | \r | |
337 | If ExtendedData is NULL, then ASSERT().\r | |
338 | If ExtendedDataSize is 0, then ASSERT().\r | |
339 | \r | |
340 | @param Type Status code type. \r | |
341 | @param Value Status code value.\r | |
342 | @param ExtendedData Pointer to the extended data buffer to be reported.\r | |
343 | @param ExtendedDataSize The size, in bytes, of the extended data buffer to \r | |
344 | be reported.\r | |
345 | \r | |
346 | @retval EFI_SUCCESS The status code was reported with the extended \r | |
347 | data specified by ExtendedData and ExtendedDataSize.\r | |
348 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r | |
349 | extended data section.\r | |
350 | @retval EFI_UNSUPPORTED Report status code is not supported\r | |
351 | \r | |
352 | **/\r | |
353 | EFI_STATUS\r | |
354 | EFIAPI\r | |
355 | ReportStatusCodeWithExtendedData (\r | |
356 | IN EFI_STATUS_CODE_TYPE Type,\r | |
357 | IN EFI_STATUS_CODE_VALUE Value,\r | |
8960cdeb | 358 | IN CONST VOID *ExtendedData,\r |
878ddf1f | 359 | IN UINTN ExtendedDataSize\r |
360 | )\r | |
361 | {\r | |
362 | ASSERT (ExtendedData != NULL);\r | |
363 | ASSERT (ExtendedDataSize != 0);\r | |
364 | return ReportStatusCodeEx (\r | |
365 | Type,\r | |
366 | Value,\r | |
367 | 0,\r | |
368 | NULL,\r | |
369 | NULL,\r | |
370 | ExtendedData,\r | |
371 | ExtendedDataSize\r | |
372 | );\r | |
373 | }\r | |
374 | \r | |
375 | \r | |
376 | /**\r | |
377 | Reports a status code with full parameters.\r | |
378 | \r | |
379 | The function reports a status code. If ExtendedData is NULL and ExtendedDataSize \r | |
380 | is 0, then an extended data buffer is not reported. If ExtendedData is not \r | |
381 | NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated. \r | |
382 | ExtendedData is assumed not have the standard status code header, so this function \r | |
383 | is responsible for allocating a buffer large enough for the standard header and \r | |
384 | the extended data passed into this function. The standard header is filled in \r | |
385 | with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a \r | |
386 | GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with \r | |
387 | an instance specified by Instance and a caller ID specified by CallerId. If \r | |
388 | CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r | |
389 | \r | |
390 | ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx() \r | |
391 | is called while processing another any other Report Status Code Library function, \r | |
392 | then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r | |
393 | \r | |
394 | If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r | |
395 | If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r | |
396 | \r | |
397 | @param Type Status code type. \r | |
398 | @param Value Status code value.\r | |
399 | @param Instance Status code instance number.\r | |
400 | @param CallerId Pointer to a GUID that identifies the caller of this \r | |
401 | function. If this parameter is NULL, then a caller \r | |
402 | ID of gEfiCallerIdGuid is used.\r | |
403 | @param ExtendedDataGuid Pointer to the GUID for the extended data buffer. \r | |
404 | If this parameter is NULL, then a the status code \r | |
405 | standard header is filled in with \r | |
406 | gEfiStatusCodeSpecificDataGuid.\r | |
407 | @param ExtendedData Pointer to the extended data buffer. This is an \r | |
408 | optional parameter that may be NULL.\r | |
409 | @param ExtendedDataSize The size, in bytes, of the extended data buffer.\r | |
410 | \r | |
411 | @retval EFI_SUCCESS The status code was reported.\r | |
412 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate \r | |
413 | the extended data section if it was specified.\r | |
414 | @retval EFI_UNSUPPORTED Report status code is not supported\r | |
415 | \r | |
416 | **/\r | |
417 | EFI_STATUS\r | |
418 | EFIAPI\r | |
419 | ReportStatusCodeEx (\r | |
420 | IN EFI_STATUS_CODE_TYPE Type,\r | |
421 | IN EFI_STATUS_CODE_VALUE Value,\r | |
422 | IN UINT32 Instance,\r | |
8960cdeb | 423 | IN CONST EFI_GUID *CallerId OPTIONAL,\r |
424 | IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,\r | |
425 | IN CONST VOID *ExtendedData OPTIONAL,\r | |
878ddf1f | 426 | IN UINTN ExtendedDataSize\r |
427 | )\r | |
428 | {\r | |
429 | EFI_STATUS_CODE_DATA *StatusCodeData;\r | |
430 | UINT64 Buffer[MAX_EXTENDED_DATA_SIZE / sizeof (UINT64)];\r | |
431 | \r | |
432 | ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));\r | |
433 | ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));\r | |
434 | \r | |
435 | if (ExtendedDataSize > (MAX_EXTENDED_DATA_SIZE - sizeof (EFI_STATUS_CODE_DATA))) {\r | |
436 | return EFI_OUT_OF_RESOURCES;\r | |
437 | }\r | |
438 | StatusCodeData = (EFI_STATUS_CODE_DATA *)Buffer;\r | |
439 | StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r | |
440 | StatusCodeData->Size = (UINT16)ExtendedDataSize;\r | |
441 | if (ExtendedDataGuid == NULL) {\r | |
442 | ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;\r | |
443 | }\r | |
444 | CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);\r | |
445 | CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);\r | |
446 | if (CallerId == NULL) {\r | |
447 | CallerId = &gEfiCallerIdGuid;\r | |
448 | }\r | |
449 | return InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);\r | |
450 | }\r | |
451 | \r | |
452 | \r | |
453 | /**\r | |
454 | Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r | |
455 | \r | |
456 | This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED \r | |
457 | bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r | |
458 | \r | |
459 | @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of \r | |
460 | PcdReportStatusCodeProperyMask is set.\r | |
461 | @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of \r | |
462 | PcdReportStatusCodeProperyMask is clear.\r | |
463 | \r | |
464 | **/\r | |
465 | BOOLEAN\r | |
466 | EFIAPI\r | |
467 | ReportProgressCodeEnabled (\r | |
468 | VOID\r | |
469 | )\r | |
470 | {\r | |
471 | return ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);\r | |
472 | }\r | |
473 | \r | |
474 | \r | |
475 | /**\r | |
476 | Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r | |
477 | \r | |
478 | This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED \r | |
479 | bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r | |
480 | \r | |
481 | @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r | |
482 | PcdReportStatusCodeProperyMask is set.\r | |
483 | @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r | |
484 | PcdReportStatusCodeProperyMask is clear.\r | |
485 | \r | |
486 | **/\r | |
487 | BOOLEAN\r | |
488 | EFIAPI\r | |
489 | ReportErrorCodeEnabled (\r | |
490 | VOID\r | |
491 | )\r | |
492 | {\r | |
493 | return ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);\r | |
494 | }\r | |
495 | \r | |
496 | \r | |
497 | /**\r | |
498 | Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r | |
499 | \r | |
500 | This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED \r | |
501 | bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r | |
502 | \r | |
503 | @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of \r | |
504 | PcdReportStatusCodeProperyMask is set.\r | |
505 | @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of \r | |
506 | PcdReportStatusCodeProperyMask is clear.\r | |
507 | \r | |
508 | **/\r | |
509 | BOOLEAN\r | |
510 | EFIAPI\r | |
511 | ReportDebugCodeEnabled (\r | |
512 | VOID\r | |
513 | )\r | |
514 | {\r | |
515 | return ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r | |
516 | }\r |