2 API implementation for instance of Report Status Code Library.
4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 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 #include <Library/ReportStatusCodeLib.h>
16 #include <Library/BaseLib.h>
17 #include <Library/DebugLib.h>
18 #include <Library/UefiBootServicesTableLib.h>
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/PcdLib.h>
21 #include <Library/DevicePathLib.h>
22 #include <Library/UefiRuntimeLib.h>
24 #include <Protocol/StatusCode.h>
26 #include <Guid/StatusCodeDataTypeId.h>
27 #include <Guid/StatusCodeDataTypeDebug.h>
28 #include <Guid/EventGroup.h>
32 // Define the maximum extended data size that is supported when a status code is reported.
34 #define MAX_EXTENDED_DATA_SIZE 0x200
36 EFI_STATUS_CODE_PROTOCOL
*mReportStatusCodeLibStatusCodeProtocol
= NULL
;
37 EFI_EVENT mReportStatusCodeLibVirtualAddressChangeEvent
;
38 EFI_EVENT mReportStatusCodeLibExitBootServicesEvent
;
39 BOOLEAN mHaveExitedBootServices
= FALSE
;
42 Locate the report status code service.
44 Retrieve ReportStatusCode() API of Report Status Code Protocol.
48 InternalGetReportStatusCode (
54 if (mReportStatusCodeLibStatusCodeProtocol
!= NULL
) {
58 if (mHaveExitedBootServices
) {
63 // Check gBS just in case ReportStatusCode is called before gBS is initialized.
65 if (gBS
!= NULL
&& gBS
->LocateProtocol
!= NULL
) {
66 Status
= gBS
->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid
, NULL
, (VOID
**) &mReportStatusCodeLibStatusCodeProtocol
);
67 if (EFI_ERROR (Status
)) {
68 mReportStatusCodeLibStatusCodeProtocol
= NULL
;
74 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
76 @param Event Event whose notification function is being invoked.
77 @param Context Pointer to the notification function's context
82 ReportStatusCodeLibVirtualAddressChange (
87 if (mReportStatusCodeLibStatusCodeProtocol
== NULL
) {
90 EfiConvertPointer (0, (VOID
**) &mReportStatusCodeLibStatusCodeProtocol
);
94 Notification function of EVT_SIGNAL_EXIT_BOOT_SERVICES.
96 @param Event Event whose notification function is being invoked.
97 @param Context Pointer to the notification function's context
102 ReportStatusCodeLibExitBootServices (
108 // Locate the report status code service before enter runtime.
110 InternalGetReportStatusCode ();
112 mHaveExitedBootServices
= TRUE
;
116 The constructor function of Runtime DXE Report Status Code Lib.
118 This function allocates memory for extended status code data, caches
119 the report status code service, and registers events.
121 @param ImageHandle The firmware allocated handle for the EFI image.
122 @param SystemTable A pointer to the EFI System Table.
124 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
129 ReportStatusCodeLibConstructor (
130 IN EFI_HANDLE ImageHandle
,
131 IN EFI_SYSTEM_TABLE
*SystemTable
137 // Cache the report status code service
139 InternalGetReportStatusCode ();
142 // Register notify function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
144 Status
= gBS
->CreateEventEx (
147 ReportStatusCodeLibVirtualAddressChange
,
149 &gEfiEventVirtualAddressChangeGuid
,
150 &mReportStatusCodeLibVirtualAddressChangeEvent
152 ASSERT_EFI_ERROR (Status
);
155 // Register notify function for EVT_SIGNAL_EXIT_BOOT_SERVICES
157 Status
= gBS
->CreateEventEx (
160 ReportStatusCodeLibExitBootServices
,
162 &gEfiEventExitBootServicesGuid
,
163 &mReportStatusCodeLibExitBootServicesEvent
165 ASSERT_EFI_ERROR (Status
);
171 The destructor function of Runtime DXE Report Status Code Lib.
173 The destructor function frees memory allocated by constructor, and closes related events.
174 It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS.
176 @param ImageHandle The firmware allocated handle for the EFI image.
177 @param SystemTable A pointer to the EFI System Table.
179 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
184 ReportStatusCodeLibDestructor (
185 IN EFI_HANDLE ImageHandle
,
186 IN EFI_SYSTEM_TABLE
*SystemTable
191 ASSERT (gBS
!= NULL
);
192 Status
= gBS
->CloseEvent (mReportStatusCodeLibVirtualAddressChangeEvent
);
193 ASSERT_EFI_ERROR (Status
);
195 Status
= gBS
->CloseEvent (mReportStatusCodeLibExitBootServicesEvent
);
196 ASSERT_EFI_ERROR (Status
);
202 Internal worker function that reports a status code through the Report Status Code Protocol.
204 If status code service is not cached, then this function checks if Report Status Code
205 Protocol is available in system. If Report Status Code Protocol is not available, then
206 EFI_UNSUPPORTED is returned. If Report Status Code Protocol is present, then it is
207 cached in mReportStatusCodeLibStatusCodeProtocol. Finally this function reports status
208 code through the Report Status Code Protocol.
210 @param Type Status code type.
211 @param Value Status code value.
212 @param Instance Status code instance number.
213 @param CallerId Pointer to a GUID that identifies the caller of this
214 function. This is an optional parameter that may be
216 @param Data Pointer to the extended data buffer. This is an
217 optional parameter that may be NULL.
219 @retval EFI_SUCCESS The status code was reported.
220 @retval EFI_UNSUPPORTED Report Status Code Protocol is not available.
221 @retval EFI_UNSUPPORTED Status code type is not supported.
225 InternalReportStatusCode (
226 IN EFI_STATUS_CODE_TYPE Type
,
227 IN EFI_STATUS_CODE_VALUE Value
,
229 IN CONST EFI_GUID
*CallerId OPTIONAL
,
230 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
233 if ((ReportProgressCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
234 (ReportErrorCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) ||
235 (ReportDebugCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
)) {
237 // If mReportStatusCodeLibStatusCodeProtocol is NULL, then check if Report Status Code Protocol is available in system.
239 InternalGetReportStatusCode ();
240 if (mReportStatusCodeLibStatusCodeProtocol
== NULL
) {
241 return EFI_UNSUPPORTED
;
245 // A Report Status Code Protocol is present in system, so pass in all the parameters to the service.
247 return mReportStatusCodeLibStatusCodeProtocol
->ReportStatusCode (Type
, Value
, Instance
, (EFI_GUID
*)CallerId
, Data
);
250 return EFI_UNSUPPORTED
;
255 Converts a status code to an 8-bit POST code value.
257 Converts the status code specified by CodeType and Value to an 8-bit POST code
258 and returns the 8-bit POST code in PostCode. If CodeType is an
259 EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
260 are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
261 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
263 If PostCode is NULL, then ASSERT().
265 @param CodeType The type of status code being converted.
266 @param Value The status code value being converted.
267 @param PostCode A pointer to the 8-bit POST code value to return.
269 @retval TRUE The status code specified by CodeType and Value was converted
270 to an 8-bit POST code and returned in PostCode.
271 @retval FALSE The status code specified by CodeType and Value could not be
272 converted to an 8-bit POST code value.
278 IN EFI_STATUS_CODE_TYPE CodeType
,
279 IN EFI_STATUS_CODE_VALUE Value
,
284 // If PostCode is NULL, then ASSERT()
286 ASSERT (PostCode
!= NULL
);
289 // Convert Value to an 8 bit post code
291 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
292 ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) ) {
293 *PostCode
= (UINT8
) ((((Value
& EFI_STATUS_CODE_CLASS_MASK
) >> 24) << 5) |
294 (((Value
& EFI_STATUS_CODE_SUBCLASS_MASK
) >> 16) & 0x1f));
302 Extracts ASSERT() information from a status code structure.
304 Converts the status code specified by CodeType, Value, and Data to the ASSERT()
305 arguments specified by Filename, Description, and LineNumber. If CodeType is
306 an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
307 Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
308 Filename, Description, and LineNumber from the optional data area of the
309 status code buffer specified by Data. The optional data area of Data contains
310 a Null-terminated ASCII string for the FileName, followed by a Null-terminated
311 ASCII string for the Description, followed by a 32-bit LineNumber. If the
312 ASSERT() information could be extracted from Data, then return TRUE.
313 Otherwise, FALSE is returned.
315 If Data is NULL, then ASSERT().
316 If Filename is NULL, then ASSERT().
317 If Description is NULL, then ASSERT().
318 If LineNumber is NULL, then ASSERT().
320 @param CodeType The type of status code being converted.
321 @param Value The status code value being converted.
322 @param Data Pointer to status code data buffer.
323 @param Filename Pointer to the source file name that generated the ASSERT().
324 @param Description Pointer to the description of the ASSERT().
325 @param LineNumber Pointer to source line number that generated the ASSERT().
327 @retval TRUE The status code specified by CodeType, Value, and Data was
328 converted ASSERT() arguments specified by Filename, Description,
330 @retval FALSE The status code specified by CodeType, Value, and Data could
331 not be converted to ASSERT() arguments.
336 ReportStatusCodeExtractAssertInfo (
337 IN EFI_STATUS_CODE_TYPE CodeType
,
338 IN EFI_STATUS_CODE_VALUE Value
,
339 IN CONST EFI_STATUS_CODE_DATA
*Data
,
340 OUT CHAR8
**Filename
,
341 OUT CHAR8
**Description
,
342 OUT UINT32
*LineNumber
345 EFI_DEBUG_ASSERT_DATA
*AssertData
;
347 ASSERT (Data
!= NULL
);
348 ASSERT (Filename
!= NULL
);
349 ASSERT (Description
!= NULL
);
350 ASSERT (LineNumber
!= NULL
);
352 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
353 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
) &&
354 ((Value
& EFI_STATUS_CODE_OPERATION_MASK
) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)) {
355 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)(Data
+ 1);
356 *Filename
= (CHAR8
*)(AssertData
+ 1);
357 *Description
= *Filename
+ AsciiStrLen (*Filename
) + 1;
358 *LineNumber
= AssertData
->LineNumber
;
366 Extracts DEBUG() information from a status code structure.
368 Converts the status code specified by Data to the DEBUG() arguments specified
369 by ErrorLevel, Marker, and Format. If type GUID in Data is
370 EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
371 Format from the optional data area of the status code buffer specified by Data.
372 The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
373 which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
374 the Format. If the DEBUG() information could be extracted from Data, then
375 return TRUE. Otherwise, FALSE is returned.
377 If Data is NULL, then ASSERT().
378 If ErrorLevel is NULL, then ASSERT().
379 If Marker is NULL, then ASSERT().
380 If Format is NULL, then ASSERT().
382 @param Data Pointer to status code data buffer.
383 @param ErrorLevel Pointer to error level mask for a debug message.
384 @param Marker Pointer to the variable argument list associated with Format.
385 @param Format Pointer to a Null-terminated ASCII format string of a
388 @retval TRUE The status code specified by Data was converted DEBUG() arguments
389 specified by ErrorLevel, Marker, and Format.
390 @retval FALSE The status code specified by Data could not be converted to
396 ReportStatusCodeExtractDebugInfo (
397 IN CONST EFI_STATUS_CODE_DATA
*Data
,
398 OUT UINT32
*ErrorLevel
,
399 OUT BASE_LIST
*Marker
,
403 EFI_DEBUG_INFO
*DebugInfo
;
405 ASSERT (Data
!= NULL
);
406 ASSERT (ErrorLevel
!= NULL
);
407 ASSERT (Marker
!= NULL
);
408 ASSERT (Format
!= NULL
);
411 // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
413 if (!CompareGuid (&Data
->Type
, &gEfiStatusCodeDataTypeDebugGuid
)) {
418 // Retrieve the debug information from the status code record
420 DebugInfo
= (EFI_DEBUG_INFO
*)(Data
+ 1);
422 *ErrorLevel
= DebugInfo
->ErrorLevel
;
425 // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
426 // of format in DEBUG string. Its address is returned in Marker and has to be 64-bit aligned.
427 // It must be noticed that EFI_DEBUG_INFO follows EFI_STATUS_CODE_DATA, whose size is
428 // 20 bytes. The size of EFI_DEBUG_INFO is 4 bytes, so we can ensure that Marker
429 // returned is 64-bit aligned.
430 // 64-bit aligned is a must, otherwise retrieving 64-bit parameter from BASE_LIST will
431 // cause unalignment exception.
433 *Marker
= (BASE_LIST
) (DebugInfo
+ 1);
434 *Format
= (CHAR8
*)(((UINT64
*)*Marker
) + 12);
441 Reports a status code.
443 Reports the status code specified by the parameters Type and Value. Status
444 code also require an instance, caller ID, and extended data. This function
445 passed in a zero instance, NULL extended data, and a caller ID of
446 gEfiCallerIdGuid, which is the GUID for the module.
448 ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
449 is called while processing another any other Report Status Code Library function,
450 then ReportStatusCode() must return immediately.
452 @param Type Status code type.
453 @param Value Status code value.
455 @retval EFI_SUCCESS The status code was reported.
456 @retval EFI_DEVICE_ERROR There status code could not be reported due to a
458 @retval EFI_UNSUPPORTED Report status code is not supported
464 IN EFI_STATUS_CODE_TYPE Type
,
465 IN EFI_STATUS_CODE_VALUE Value
468 return InternalReportStatusCode (Type
, Value
, 0, &gEfiCallerIdGuid
, NULL
);
473 Reports a status code with a Device Path Protocol as the extended data.
475 Allocates and fills in the extended data section of a status code with the
476 Device Path Protocol specified by DevicePath. This function is responsible
477 for allocating a buffer large enough for the standard header and the device
478 path. The standard header is filled in with a GUID of
479 gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero
480 instance and a caller ID of gEfiCallerIdGuid.
482 ReportStatusCodeWithDevicePath()must actively prevent recursion. If
483 ReportStatusCodeWithDevicePath() is called while processing another any other
484 Report Status Code Library function, then ReportStatusCodeWithDevicePath()
485 must return EFI_DEVICE_ERROR immediately.
487 If DevicePath is NULL, then ASSERT().
489 @param Type Status code type.
490 @param Value Status code value.
491 @param DevicePath Pointer to the Device Path Protocol to be reported.
493 @retval EFI_SUCCESS The status code was reported with the extended
494 data specified by DevicePath.
495 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
496 extended data section.
497 @retval EFI_UNSUPPORTED Report status code is not supported
502 ReportStatusCodeWithDevicePath (
503 IN EFI_STATUS_CODE_TYPE Type
,
504 IN EFI_STATUS_CODE_VALUE Value
,
505 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
508 ASSERT (DevicePath
!= NULL
);
509 return ReportStatusCodeWithExtendedData (
513 GetDevicePathSize (DevicePath
)
519 Reports a status code with an extended data buffer.
521 Allocates and fills in the extended data section of a status code with the
522 extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
523 is assumed to be one of the data structures specified in Related Definitions.
524 These data structure do not have the standard header, so this function is
525 responsible for allocating a buffer large enough for the standard header and
526 the extended data passed into this function. The standard header is filled
527 in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
528 with a zero instance and a caller ID of gEfiCallerIdGuid.
530 ReportStatusCodeWithExtendedData()must actively prevent recursion. If
531 ReportStatusCodeWithExtendedData() is called while processing another any other
532 Report Status Code Library function, then ReportStatusCodeWithExtendedData()
533 must return EFI_DEVICE_ERROR immediately.
535 If ExtendedData is NULL, then ASSERT().
536 If ExtendedDataSize is 0, then ASSERT().
538 @param Type Status code type.
539 @param Value Status code value.
540 @param ExtendedData Pointer to the extended data buffer to be reported.
541 @param ExtendedDataSize The size, in bytes, of the extended data buffer to
544 @retval EFI_SUCCESS The status code was reported with the extended
545 data specified by ExtendedData and ExtendedDataSize.
546 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
547 extended data section.
548 @retval EFI_UNSUPPORTED Report status code is not supported
553 ReportStatusCodeWithExtendedData (
554 IN EFI_STATUS_CODE_TYPE Type
,
555 IN EFI_STATUS_CODE_VALUE Value
,
556 IN CONST VOID
*ExtendedData
,
557 IN UINTN ExtendedDataSize
560 ASSERT (ExtendedData
!= NULL
);
561 ASSERT (ExtendedDataSize
!= 0);
562 return ReportStatusCodeEx (
575 Reports a status code with full parameters.
577 The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
578 is 0, then an extended data buffer is not reported. If ExtendedData is not
579 NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
580 ExtendedData is assumed not have the standard status code header, so this function
581 is responsible for allocating a buffer large enough for the standard header and
582 the extended data passed into this function. The standard header is filled in
583 with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
584 GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with
585 an instance specified by Instance and a caller ID specified by CallerId. If
586 CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
588 ReportStatusCodeEx()must actively prevent recursion. If
589 ReportStatusCodeEx() is called while processing another any
590 other Report Status Code Library function, then
591 ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
593 If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
594 If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
596 @param Type Status code type.
597 @param Value Status code value.
598 @param Instance Status code instance number.
599 @param CallerId Pointer to a GUID that identifies the caller of this
600 function. If this parameter is NULL, then a caller
601 ID of gEfiCallerIdGuid is used.
602 @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
603 If this parameter is NULL, then a the status code
604 standard header is filled in with
605 gEfiStatusCodeSpecificDataGuid.
606 @param ExtendedData Pointer to the extended data buffer. This is an
607 optional parameter that may be NULL.
608 @param ExtendedDataSize The size, in bytes, of the extended data buffer.
610 @retval EFI_SUCCESS The status code was reported.
611 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
612 the extended data section if it was specified.
613 @retval EFI_UNSUPPORTED Report status code is not supported
619 IN EFI_STATUS_CODE_TYPE Type
,
620 IN EFI_STATUS_CODE_VALUE Value
,
622 IN CONST EFI_GUID
*CallerId OPTIONAL
,
623 IN CONST EFI_GUID
*ExtendedDataGuid OPTIONAL
,
624 IN CONST VOID
*ExtendedData OPTIONAL
,
625 IN UINTN ExtendedDataSize
629 EFI_STATUS_CODE_DATA
*StatusCodeData
;
630 UINT64 StatusCodeBuffer
[(MAX_EXTENDED_DATA_SIZE
/ sizeof (UINT64
)) + 1];
632 ASSERT (!((ExtendedData
== NULL
) && (ExtendedDataSize
!= 0)));
633 ASSERT (!((ExtendedData
!= NULL
) && (ExtendedDataSize
== 0)));
635 if (mHaveExitedBootServices
) {
636 if (sizeof (EFI_STATUS_CODE_DATA
) + ExtendedDataSize
> MAX_EXTENDED_DATA_SIZE
) {
637 return EFI_OUT_OF_RESOURCES
;
639 StatusCodeData
= (EFI_STATUS_CODE_DATA
*) StatusCodeBuffer
;
641 if (gBS
== NULL
|| gBS
->AllocatePool
== NULL
|| gBS
->FreePool
== NULL
) {
642 return EFI_UNSUPPORTED
;
646 // Allocate space for the Status Code Header and its buffer
648 StatusCodeData
= NULL
;
649 gBS
->AllocatePool (EfiBootServicesData
, sizeof (EFI_STATUS_CODE_DATA
) + ExtendedDataSize
, (VOID
**)&StatusCodeData
);
650 if (StatusCodeData
== NULL
) {
651 return EFI_OUT_OF_RESOURCES
;
656 // Fill in the extended data header
658 StatusCodeData
->HeaderSize
= (UINT16
) sizeof (EFI_STATUS_CODE_DATA
);
659 StatusCodeData
->Size
= (UINT16
) ExtendedDataSize
;
660 if (ExtendedDataGuid
== NULL
) {
661 ExtendedDataGuid
= &gEfiStatusCodeSpecificDataGuid
;
663 CopyGuid (&StatusCodeData
->Type
, ExtendedDataGuid
);
666 // Fill in the extended data buffer
668 if (ExtendedData
!= NULL
) {
669 CopyMem (StatusCodeData
+ 1, ExtendedData
, ExtendedDataSize
);
673 // Report the status code
675 if (CallerId
== NULL
) {
676 CallerId
= &gEfiCallerIdGuid
;
678 Status
= InternalReportStatusCode (Type
, Value
, Instance
, CallerId
, StatusCodeData
);
681 // Free the allocated buffer
683 if (!mHaveExitedBootServices
) {
684 gBS
->FreePool (StatusCodeData
);
692 Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
694 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
695 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
697 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
698 PcdReportStatusCodeProperyMask is set.
699 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
700 PcdReportStatusCodeProperyMask is clear.
705 ReportProgressCodeEnabled (
709 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
) != 0);
714 Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
716 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
717 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
719 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
720 PcdReportStatusCodeProperyMask is set.
721 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
722 PcdReportStatusCodeProperyMask is clear.
727 ReportErrorCodeEnabled (
731 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
) != 0);
736 Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
738 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
739 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
741 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
742 PcdReportStatusCodeProperyMask is set.
743 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
744 PcdReportStatusCodeProperyMask is clear.
749 ReportDebugCodeEnabled (
753 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
) != 0);