EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/DxeReportStatusCodeLib/ReportStatusCodeLib.c

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   ReportStatusCodeLib.c
  16
  17 Abstract:
  18
  19   Report Status Code Library for DXE Phase.
  20
  21 --*/
  22
  23 #include "EdkIIGlueDxe.h"
  24
  25 //
  26 // Global pointer to the Status Code Protocol
  27 //
  28 static EFI_STATUS_CODE_PROTOCOL  *gStatusCode = NULL;
  29
  30
  31 /**
  32   Internal worker function that reports a status code through the Status Code Protocol
  33
  34   This function checks to see if a Status Code Protocol is present in the handle
  35   database.  If a Status Code Protocol is not present, then EFI_UNSUPPORTED is
  36   returned.  If a Status Code Protocol is present, then it is cached in gStatusCode,
  37   and the ReportStatusCode() service of the Status Code Protocol is called passing in
  38   Type, Value, Instance, CallerId, and Data.  The result of this call is returned.
  39
  40   @param  Type              Status code type.
  41   @param  Value             Status code value.
  42   @param  Instance          Status code instance number.
  43   @param  CallerId          Pointer to a GUID that identifies the caller of this
  44                             function.  This is an optional parameter that may be
  45                             NULL.
  46   @param  Data              Pointer to the extended data buffer.  This is an
  47                             optional parameter that may be NULL.
  48
  49   @retval  EFI_SUCCESS           The status code was reported.
  50   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to report the status code.
  51   @retval  EFI_UNSUPPORTED       Status Code Protocol is not available.
  52
  53 **/
  54 STATIC
  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   EFI_STATUS  Status;
  65
  66   if (gRT == NULL) {
  67     return EFI_UNSUPPORTED;
  68   }
  69
  70   if (gRT->Hdr.Revision >= 0x00020000) {
  71     //
  72     // If gStatusCode is NULL, then see if a Status Code Protocol instance is present
  73     // in the handle database.
  74     //
  75     if (gStatusCode == NULL) {
  76       Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID **)&gStatusCode);
  77       if (EFI_ERROR (Status) || gStatusCode == NULL) {
  78         return EFI_UNSUPPORTED;
  79       }
  80     }
  81
  82     //
  83     // A Status Code Protocol is present in the handle database, so pass in all the
  84     // parameters to the ReportStatusCode() service of the Status Code Protocol
  85     //
  86     return (gStatusCode->ReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);
  87   } else {
  88 #if (EFI_SPECIFICATION_VERSION < 0x00020000)
  89     return (gRT->ReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);
  90 #else
  91     return EFI_UNSUPPORTED;
  92 #endif
  93   }
  94
  95 }
  96
  97
  98 /**
  99   Computes and returns the size, in bytes, of a device path.
 100
 101   @param  DevicePath  A pointer to a device path.
 102
 103   @return  The size, in bytes, of DevicePath.
 104
 105 **/
 106 STATIC
 107 UINTN
 108 InternalReportStatusCodeDevicePathSize (
 109   IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
 110   )
 111 {
 112   CONST EFI_DEVICE_PATH_PROTOCOL  *Start;
 113
 114   //
 115   // Search for the end of the device path structure
 116   //
 117   Start = DevicePath;
 118   while (!EfiIsDevicePathEnd (DevicePath)) {
 119     DevicePath = EfiNextDevicePathNode (DevicePath);
 120   }
 121
 122   //
 123   // Subtract the start node from the end node and add in the size of the end node
 124   //
 125   return ((UINTN) DevicePath - (UINTN) Start) + DevicePathNodeLength (DevicePath);
 126 }
 127
 128
 129 /**
 130   Converts a status code to an 8-bit POST code value.
 131
 132   Converts the status code specified by CodeType and Value to an 8-bit POST code
 133   and returns the 8-bit POST code in PostCode.  If CodeType is an
 134   EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
 135   are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
 136   24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.
 137
 138   If PostCode is NULL, then ASSERT().
 139
 140   @param  CodeType  The type of status code being converted.
 141   @param  Value     The status code value being converted.
 142   @param  PostCode  A pointer to the 8-bit POST code value to return.
 143
 144   @retval  TRUE   The status code specified by CodeType and Value was converted
 145                   to an 8-bit POST code and returned in  PostCode.
 146   @retval  FALSE  The status code specified by CodeType and Value could not be
 147                   converted to an 8-bit POST code value.
 148
 149 **/
 150 BOOLEAN
 151 EFIAPI
 152 GlueCodeTypeToPostCode (
 153   IN  EFI_STATUS_CODE_TYPE   CodeType,
 154   IN  EFI_STATUS_CODE_VALUE  Value,
 155   OUT UINT8                  *PostCode
 156   )
 157 {
 158   //
 159   // If PostCode is NULL, then ASSERT()
 160   //
 161   ASSERT (PostCode != NULL);
 162
 163   //
 164   // Convert Value to an 8 bit post code
 165   //
 166   if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||
 167       ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ) {
 168     *PostCode  = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |
 169                           (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));
 170     return TRUE;
 171   }
 172   return FALSE;
 173 }
 174
 175
 176 /**
 177   Extracts ASSERT() information from a status code structure.
 178
 179   Converts the status code specified by CodeType, Value, and Data to the ASSERT()
 180   arguments specified by Filename, Description, and LineNumber.  If CodeType is
 181   an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
 182   Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
 183   Filename, Description, and LineNumber from the optional data area of the
 184   status code buffer specified by Data.  The optional data area of Data contains
 185   a Null-terminated ASCII string for the FileName, followed by a Null-terminated
 186   ASCII string for the Description, followed by a 32-bit LineNumber.  If the
 187   ASSERT() information could be extracted from Data, then return TRUE.
 188   Otherwise, FALSE is returned.
 189
 190   If Data is NULL, then ASSERT().
 191   If Filename is NULL, then ASSERT().
 192   If Description is NULL, then ASSERT().
 193   If LineNumber is NULL, then ASSERT().
 194
 195   @param  CodeType     The type of status code being converted.
 196   @param  Value        The status code value being converted.
 197   @param  Data         Pointer to status code data buffer.
 198   @param  Filename     Pointer to the source file name that generated the ASSERT().
 199   @param  Description  Pointer to the description of the ASSERT().
 200   @param  LineNumber   Pointer to source line number that generated the ASSERT().
 201
 202   @retval  TRUE   The status code specified by CodeType, Value, and Data was
 203                   converted ASSERT() arguments specified by Filename, Description,
 204                   and LineNumber.
 205   @retval  FALSE  The status code specified by CodeType, Value, and Data could
 206                   not be converted to ASSERT() arguments.
 207
 208 **/
 209 BOOLEAN
 210 EFIAPI
 211 GlueReportStatusCodeExtractAssertInfo (
 212   IN EFI_STATUS_CODE_TYPE        CodeType,
 213   IN EFI_STATUS_CODE_VALUE       Value,
 214   IN CONST EFI_STATUS_CODE_DATA  *Data,
 215   OUT CHAR8                      **Filename,
 216   OUT CHAR8                      **Description,
 217   OUT UINT32                     *LineNumber
 218   )
 219 {
 220   EFI_DEBUG_ASSERT_DATA  *AssertData;
 221
 222   ASSERT (Data        != NULL);
 223   ASSERT (Filename    != NULL);
 224   ASSERT (Description != NULL);
 225   ASSERT (LineNumber  != NULL);
 226
 227   if (((CodeType & EFI_STATUS_CODE_TYPE_MASK)      == EFI_ERROR_CODE) &&
 228       ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK)  == EFI_ERROR_UNRECOVERED) &&
 229       ((Value    & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {
 230     AssertData   = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);
 231     *Filename    = (CHAR8 *)(AssertData + 1);
 232     *Description = *Filename + AsciiStrLen (*Filename) + 1;
 233     *LineNumber  = AssertData->LineNumber;
 234     return TRUE;
 235   }
 236   return FALSE;
 237 }
 238
 239
 240 /**
 241   Extracts DEBUG() information from a status code structure.
 242
 243   Converts the status code specified by Data to the DEBUG() arguments specified
 244   by ErrorLevel, Marker, and Format.  If type GUID in Data is
 245   EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
 246   Format from the optional data area of the status code buffer specified by Data.
 247   The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
 248   which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
 249   the Format.  If the DEBUG() information could be extracted from Data, then
 250   return TRUE.  Otherwise, FALSE is returned.
 251
 252   If Data is NULL, then ASSERT().
 253   If ErrorLevel is NULL, then ASSERT().
 254   If Marker is NULL, then ASSERT().
 255   If Format is NULL, then ASSERT().
 256
 257   @param  Data        Pointer to status code data buffer.
 258   @param  ErrorLevel  Pointer to error level mask for a debug message.
 259   @param  Marker      Pointer to the variable argument list associated with Format.
 260   @param  Format      Pointer to a Null-terminated ASCII format string of a
 261                       debug message.
 262
 263   @retval  TRUE   The status code specified by Data was converted DEBUG() arguments
 264                   specified by ErrorLevel, Marker, and Format.
 265   @retval  FALSE  The status code specified by Data could not be converted to
 266                   DEBUG() arguments.
 267
 268 **/
 269 BOOLEAN
 270 EFIAPI
 271 GlueReportStatusCodeExtractDebugInfo (
 272   IN CONST EFI_STATUS_CODE_DATA  *Data,
 273   OUT UINT32                     *ErrorLevel,
 274   OUT VA_LIST                    *Marker,
 275   OUT CHAR8                      **Format
 276   )
 277 {
 278   EFI_DEBUG_INFO  *DebugInfo;
 279
 280   ASSERT (Data       != NULL);
 281   ASSERT (ErrorLevel != NULL);
 282   ASSERT (Marker     != NULL);
 283   ASSERT (Format     != NULL);
 284
 285   //
 286   // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
 287   //
 288   if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {
 289     return FALSE;
 290   }
 291
 292   //
 293   // Retrieve the debug information from the status code record
 294   //
 295   DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);
 296
 297   *ErrorLevel = DebugInfo->ErrorLevel;
 298
 299   //
 300   // The first 12 * UINTN bytes of the string are really an
 301   // argument stack to support varargs on the Format string.
 302   //
 303   *Marker = (VA_LIST) (DebugInfo + 1);
 304   *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);
 305
 306   return TRUE;
 307 }
 308
 309
 310 /**
 311   Reports a status code.
 312
 313   Reports the status code specified by the parameters Type and Value.  Status
 314   code also require an instance, caller ID, and extended data.  This function
 315   passed in a zero instance, NULL extended data, and a caller ID of
 316   gEfiCallerIdGuid, which is the GUID for the module.
 317
 318   ReportStatusCode()must actively prevent recusrsion.  If ReportStatusCode()
 319   is called while processing another any other Report Status Code Library function,
 320   then ReportStatusCode() must return immediately.
 321
 322   @param  Type   Status code type.
 323   @param  Value  Status code value.
 324
 325   @retval  EFI_SUCCESS       The status code was reported.
 326   @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a
 327                              device error.
 328   @retval  EFI_UNSUPPORTED   Report status code is not supported
 329
 330 **/
 331 EFI_STATUS
 332 EFIAPI
 333 GlueReportStatusCode (
 334   IN EFI_STATUS_CODE_TYPE   Type,
 335   IN EFI_STATUS_CODE_VALUE  Value
 336   )
 337 {
 338   return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);
 339 }
 340
 341
 342 /**
 343   Reports a status code with a Device Path Protocol as the extended data.
 344
 345   Allocates and fills in the extended data section of a status code with the
 346   Device Path Protocol specified by DevicePath.  This function is responsible
 347   for allocating a buffer large enough for the standard header and the device
 348   path.  The standard header is filled in with a GUID of
 349   gEfiStatusCodeSpecificDataGuid.  The status code is reported with a zero
 350   instance and a caller ID of gEfiCallerIdGuid.
 351
 352   ReportStatusCodeWithDevicePath()must actively prevent recursion.  If
 353   ReportStatusCodeWithDevicePath() is called while processing another any other
 354   Report Status Code Library function, then ReportStatusCodeWithDevicePath()
 355   must return EFI_DEVICE_ERROR immediately.
 356
 357   If DevicePath is NULL, then ASSERT().
 358
 359   @param  Type        Status code type.
 360   @param  Value       Status code value.
 361   @param  DevicePath  Pointer to the Device Path Protocol to be reported.
 362
 363   @retval  EFI_SUCCESS           The status code was reported with the extended
 364                                  data specified by DevicePath.
 365   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the
 366                                  extended data section.
 367   @retval  EFI_UNSUPPORTED       Report status code is not supported
 368
 369 **/
 370 EFI_STATUS
 371 EFIAPI
 372 GlueReportStatusCodeWithDevicePath (
 373   IN EFI_STATUS_CODE_TYPE            Type,
 374   IN EFI_STATUS_CODE_VALUE           Value,
 375   IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
 376   )
 377 {
 378   ASSERT (DevicePath != NULL);
 379   return ReportStatusCodeWithExtendedData (
 380            Type,
 381            Value,
 382            (VOID *)DevicePath,
 383            InternalReportStatusCodeDevicePathSize (DevicePath)
 384            );
 385 }
 386
 387
 388 /**
 389   Reports a status code with an extended data buffer.
 390
 391   Allocates and fills in the extended data section of a status code with the
 392   extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData
 393   is assumed to be one of the data structures specified in Related Definitions.
 394   These data structure do not have the standard header, so this function is
 395   responsible for allocating a buffer large enough for the standard header and
 396   the extended data passed into this function.  The standard header is filled
 397   in with a GUID of  gEfiStatusCodeSpecificDataGuid.  The status code is reported
 398   with a zero instance and a caller ID of gEfiCallerIdGuid.
 399
 400   ReportStatusCodeWithExtendedData()must actively prevent recursion.  If
 401   ReportStatusCodeWithExtendedData() is called while processing another any other
 402   Report Status Code Library function, then ReportStatusCodeWithExtendedData()
 403   must return EFI_DEVICE_ERROR immediately.
 404
 405   If ExtendedData is NULL, then ASSERT().
 406   If ExtendedDataSize is 0, then ASSERT().
 407
 408   @param  Type              Status code type.
 409   @param  Value             Status code value.
 410   @param  ExtendedData      Pointer to the extended data buffer to be reported.
 411   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to
 412                             be reported.
 413
 414   @retval  EFI_SUCCESS           The status code was reported with the extended
 415                                  data specified by ExtendedData and ExtendedDataSize.
 416   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the
 417                                  extended data section.
 418   @retval  EFI_UNSUPPORTED       Report status code is not supported
 419
 420 **/
 421 EFI_STATUS
 422 EFIAPI
 423 GlueReportStatusCodeWithExtendedData (
 424   IN EFI_STATUS_CODE_TYPE   Type,
 425   IN EFI_STATUS_CODE_VALUE  Value,
 426   IN CONST VOID             *ExtendedData,
 427   IN UINTN                  ExtendedDataSize
 428   )
 429 {
 430   ASSERT (ExtendedData     != NULL);
 431   ASSERT (ExtendedDataSize != 0);
 432   return ReportStatusCodeEx (
 433            Type,
 434            Value,
 435            0,
 436            NULL,
 437            NULL,
 438            ExtendedData,
 439            ExtendedDataSize
 440            );
 441 }
 442
 443
 444 /**
 445   Reports a status code with full parameters.
 446
 447   The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize
 448   is 0, then an extended data buffer is not reported.  If ExtendedData is not
 449   NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
 450   ExtendedData is assumed not have the standard status code header, so this function
 451   is responsible for allocating a buffer large enough for the standard header and
 452   the extended data passed into this function.  The standard header is filled in
 453   with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a
 454   GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with
 455   an instance specified by Instance and a caller ID specified by CallerId.  If
 456   CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
 457
 458   ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()
 459   is called while processing another any other Report Status Code Library function,
 460   then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
 461
 462   If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
 463   If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
 464
 465   @param  Type              Status code type.
 466   @param  Value             Status code value.
 467   @param  Instance          Status code instance number.
 468   @param  CallerId          Pointer to a GUID that identifies the caller of this
 469                             function.  If this parameter is NULL, then a caller
 470                             ID of gEfiCallerIdGuid is used.
 471   @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.
 472                             If this parameter is NULL, then a the status code
 473                             standard header is filled in with
 474                             gEfiStatusCodeSpecificDataGuid.
 475   @param  ExtendedData      Pointer to the extended data buffer.  This is an
 476                             optional parameter that may be NULL.
 477   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.
 478
 479   @retval  EFI_SUCCESS           The status code was reported.
 480   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate
 481                                  the extended data section if it was specified.
 482   @retval  EFI_UNSUPPORTED       Report status code is not supported
 483
 484 **/
 485 EFI_STATUS
 486 EFIAPI
 487 GlueReportStatusCodeEx (
 488   IN EFI_STATUS_CODE_TYPE   Type,
 489   IN EFI_STATUS_CODE_VALUE  Value,
 490   IN UINT32                 Instance,
 491   IN CONST EFI_GUID         *CallerId          OPTIONAL,
 492   IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,
 493   IN CONST VOID             *ExtendedData      OPTIONAL,
 494   IN UINTN                  ExtendedDataSize
 495   )
 496 {
 497   EFI_STATUS            Status;
 498   EFI_STATUS_CODE_DATA  *StatusCodeData;
 499
 500   ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));
 501   ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));
 502
 503   //
 504   // Allocate space for the Status Code Header and its buffer
 505   //
 506   StatusCodeData = NULL;
 507   (gBS->AllocatePool) (EfiBootServicesData, sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize, (VOID **)&StatusCodeData);
 508   if (StatusCodeData == NULL) {
 509     return EFI_OUT_OF_RESOURCES;
 510   }
 511
 512   //
 513   // Fill in the extended data header
 514   //
 515   StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);
 516   StatusCodeData->Size = (UINT16)ExtendedDataSize;
 517   if (ExtendedDataGuid == NULL) {
 518     ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;
 519   }
 520   CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);
 521
 522   //
 523   // Fill in the extended data buffer
 524   //
 525   CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);
 526
 527   //
 528   // Report the status code
 529   //
 530   if (CallerId == NULL) {
 531     CallerId = &gEfiCallerIdGuid;
 532   }
 533   Status = InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);
 534
 535   //
 536   // Free the allocated buffer
 537   //
 538   (gBS->FreePool) (StatusCodeData);
 539
 540   return Status;
 541 }
 542
 543
 544 /**
 545   Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
 546
 547   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
 548   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 549
 550   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
 551                   PcdReportStatusCodeProperyMask is set.
 552   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
 553                   PcdReportStatusCodeProperyMask is clear.
 554
 555 **/
 556 BOOLEAN
 557 EFIAPI
 558 GlueReportProgressCodeEnabled (
 559   VOID
 560   )
 561 {
 562   return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);
 563 }
 564
 565
 566 /**
 567   Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
 568
 569   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
 570   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 571
 572   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
 573                   PcdReportStatusCodeProperyMask is set.
 574   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
 575                   PcdReportStatusCodeProperyMask is clear.
 576
 577 **/
 578 BOOLEAN
 579 EFIAPI
 580 GlueReportErrorCodeEnabled (
 581   VOID
 582   )
 583 {
 584   return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);
 585 }
 586
 587
 588 /**
 589   Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
 590
 591   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
 592   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 593
 594   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
 595                   PcdReportStatusCodeProperyMask is set.
 596   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
 597                   PcdReportStatusCodeProperyMask is clear.
 598
 599 **/
 600 BOOLEAN
 601 EFIAPI
 602 GlueReportDebugCodeEnabled (
 603   VOID
 604   )
 605 {
 606   return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 607 }