IntelFrameworkModulePkg/Library/PeiReportStatusCodeLib/ReportStatusCodeLib.c

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