IntelFrameworkModulePkg/Library/BaseReportStatusCodeLib/BaseReportStatusCodeLib.c

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