MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLib.c

   1 /** @file
   2   Null Base Report Status Code Library instance with empty functions.
   3
   4   Copyright (c) 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 #include <Base.h>
  16 #include <Library/ReportStatusCodeLib.h>
  17 #include <Library/DebugLib.h>
  18
  19 /**
  20   Converts a status code to an 8-bit POST code value.
  21
  22   Converts the status code specified by CodeType and Value to an 8-bit POST code
  23   and returns the 8-bit POST code in PostCode.  If CodeType is an
  24   EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
  25   are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
  26   24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.
  27
  28   If PostCode is NULL, then ASSERT().
  29
  30   @param  CodeType  The type of status code being converted.
  31   @param  Value     The status code value being converted.
  32   @param  PostCode  A pointer to the 8-bit POST code value to return.
  33
  34   @retval  TRUE   The status code specified by CodeType and Value was converted
  35                   to an 8-bit POST code and returned in  PostCode.
  36   @retval  FALSE  The status code specified by CodeType and Value could not be
  37                   converted to an 8-bit POST code value.
  38
  39 **/
  40 BOOLEAN
  41 EFIAPI
  42 CodeTypeToPostCode (
  43   IN  EFI_STATUS_CODE_TYPE   CodeType,
  44   IN  EFI_STATUS_CODE_VALUE  Value,
  45   OUT UINT8                  *PostCode
  46   )
  47 {
  48   ASSERT (PostCode != NULL);
  49
  50   return FALSE;
  51 }
  52
  53
  54 /**
  55   Extracts ASSERT() information from a status code structure.
  56
  57   Converts the status code specified by CodeType, Value, and Data to the ASSERT()
  58   arguments specified by Filename, Description, and LineNumber.  If CodeType is
  59   an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
  60   Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
  61   Filename, Description, and LineNumber from the optional data area of the
  62   status code buffer specified by Data.  The optional data area of Data contains
  63   a Null-terminated ASCII string for the FileName, followed by a Null-terminated
  64   ASCII string for the Description, followed by a 32-bit LineNumber.  If the
  65   ASSERT() information could be extracted from Data, then return TRUE.
  66   Otherwise, FALSE is returned.
  67
  68   If Data is NULL, then ASSERT().
  69   If Filename is NULL, then ASSERT().
  70   If Description is NULL, then ASSERT().
  71   If LineNumber is NULL, then ASSERT().
  72
  73   @param  CodeType     The type of status code being converted.
  74   @param  Value        The status code value being converted.
  75   @param  Data         Pointer to status code data buffer.
  76   @param  Filename     Pointer to the source file name that generated the ASSERT().
  77   @param  Description  Pointer to the description of the ASSERT().
  78   @param  LineNumber   Pointer to source line number that generated the ASSERT().
  79
  80   @retval  TRUE   The status code specified by CodeType, Value, and Data was
  81                   converted ASSERT() arguments specified by Filename, Description,
  82                   and LineNumber.
  83   @retval  FALSE  The status code specified by CodeType, Value, and Data could
  84                   not be converted to ASSERT() arguments.
  85
  86 **/
  87 BOOLEAN
  88 EFIAPI
  89 ReportStatusCodeExtractAssertInfo (
  90   IN EFI_STATUS_CODE_TYPE        CodeType,
  91   IN EFI_STATUS_CODE_VALUE       Value,
  92   IN CONST EFI_STATUS_CODE_DATA  *Data,
  93   OUT CHAR8                      **Filename,
  94   OUT CHAR8                      **Description,
  95   OUT UINT32                     *LineNumber
  96   )
  97 {
  98   return FALSE;
  99 }
 100
 101
 102 /**
 103   Extracts DEBUG() information from a status code structure.
 104
 105   Converts the status code specified by Data to the DEBUG() arguments specified
 106   by ErrorLevel, Marker, and Format.  If type GUID in Data is
 107   EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
 108   Format from the optional data area of the status code buffer specified by Data.
 109   The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
 110   which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
 111   the Format.  If the DEBUG() information could be extracted from Data, then
 112   return TRUE.  Otherwise, FALSE is returned.
 113
 114   If Data is NULL, then ASSERT().
 115   If ErrorLevel is NULL, then ASSERT().
 116   If Marker is NULL, then ASSERT().
 117   If Format is NULL, then ASSERT().
 118
 119   @param  Data        Pointer to status code data buffer.
 120   @param  ErrorLevel  Pointer to error level mask for a debug message.
 121   @param  Marker      Pointer to the variable argument list associated with Format.
 122   @param  Format      Pointer to a Null-terminated ASCII format string of a
 123                       debug message.
 124
 125   @retval  TRUE   The status code specified by Data was converted DEBUG() arguments
 126                   specified by ErrorLevel, Marker, and Format.
 127   @retval  FALSE  The status code specified by Data could not be converted to
 128                   DEBUG() arguments.
 129
 130 **/
 131 BOOLEAN
 132 EFIAPI
 133 ReportStatusCodeExtractDebugInfo (
 134   IN CONST EFI_STATUS_CODE_DATA  *Data,
 135   OUT UINT32                     *ErrorLevel,
 136   OUT BASE_LIST                  *Marker,
 137   OUT CHAR8                      **Format
 138   )
 139 {
 140   ASSERT (Data          != NULL);
 141   ASSERT (ErrorLevel    != NULL);
 142   ASSERT (StartOfBuffer != NULL);
 143
 144   return FALSE;
 145 }
 146
 147
 148 /**
 149   Reports a status code.
 150
 151   Reports the status code specified by the parameters Type and Value.  Status
 152   code also require an instance, caller ID, and extended data.  This function
 153   passed in a zero instance, NULL extended data, and a caller ID of
 154   gEfiCallerIdGuid, which is the GUID for the module.
 155
 156   ReportStatusCode()must actively prevent recursion.  If ReportStatusCode()
 157   is called while processing another any other Report Status Code Library function,
 158   then ReportStatusCode() must return immediately.
 159
 160   @param  Type   Status code type.
 161   @param  Value  Status code value.
 162
 163   @retval  EFI_SUCCESS       The status code was reported.
 164   @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a
 165                              device error.
 166   @retval  EFI_UNSUPPORTED   Report status code is not supported
 167
 168 **/
 169 EFI_STATUS
 170 EFIAPI
 171 ReportStatusCode (
 172   IN EFI_STATUS_CODE_TYPE   Type,
 173   IN EFI_STATUS_CODE_VALUE  Value
 174   )
 175 {
 176   return EFI_SUCCESS;
 177 }
 178
 179
 180 /**
 181   Reports a status code with a Device Path Protocol as the extended data.
 182
 183   Allocates and fills in the extended data section of a status code with the
 184   Device Path Protocol specified by DevicePath.  This function is responsible
 185   for allocating a buffer large enough for the standard header and the device
 186   path.  The standard header is filled in with a GUID of
 187   gEfiStatusCodeSpecificDataGuid.  The status code is reported with a zero
 188   instance and a caller ID of gEfiCallerIdGuid.
 189
 190   ReportStatusCodeWithDevicePath()must actively prevent recursion.  If
 191   ReportStatusCodeWithDevicePath() is called while processing another any other
 192   Report Status Code Library function, then ReportStatusCodeWithDevicePath()
 193   must return EFI_DEVICE_ERROR immediately.
 194
 195   If DevicePath is NULL, then ASSERT().
 196
 197   @param  Type        Status code type.
 198   @param  Value       Status code value.
 199   @param  DevicePath  Pointer to the Device Path Protocol to be reported.
 200
 201   @retval  EFI_SUCCESS           The status code was reported with the extended
 202                                  data specified by DevicePath.
 203   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the
 204                                  extended data section.
 205   @retval  EFI_UNSUPPORTED       Report status code is not supported
 206
 207 **/
 208 EFI_STATUS
 209 EFIAPI
 210 ReportStatusCodeWithDevicePath (
 211   IN EFI_STATUS_CODE_TYPE            Type,
 212   IN EFI_STATUS_CODE_VALUE           Value,
 213   IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
 214   )
 215 {
 216   ASSERT (DevicePath != NULL);
 217
 218   return EFI_SUCCESS;
 219 }
 220
 221
 222 /**
 223   Reports a status code with an extended data buffer.
 224
 225   Allocates and fills in the extended data section of a status code with the
 226   extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData
 227   is assumed to be one of the data structures specified in Related Definitions.
 228   These data structure do not have the standard header, so this function is
 229   responsible for allocating a buffer large enough for the standard header and
 230   the extended data passed into this function.  The standard header is filled
 231   in with a GUID of  gEfiStatusCodeSpecificDataGuid.  The status code is reported
 232   with a zero instance and a caller ID of gEfiCallerIdGuid.
 233
 234   ReportStatusCodeWithExtendedData()must actively prevent recursion.  If
 235   ReportStatusCodeWithExtendedData() is called while processing another any other
 236   Report Status Code Library function, then ReportStatusCodeWithExtendedData()
 237   must return EFI_DEVICE_ERROR immediately.
 238
 239   If ExtendedData is NULL, then ASSERT().
 240   If ExtendedDataSize is 0, then ASSERT().
 241
 242   @param  Type              Status code type.
 243   @param  Value             Status code value.
 244   @param  ExtendedData      Pointer to the extended data buffer to be reported.
 245   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to
 246                             be reported.
 247
 248   @retval  EFI_SUCCESS           The status code was reported with the extended
 249                                  data specified by ExtendedData and ExtendedDataSize.
 250   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the
 251                                  extended data section.
 252   @retval  EFI_UNSUPPORTED       Report status code is not supported
 253
 254 **/
 255 EFI_STATUS
 256 EFIAPI
 257 ReportStatusCodeWithExtendedData (
 258   IN EFI_STATUS_CODE_TYPE   Type,
 259   IN EFI_STATUS_CODE_VALUE  Value,
 260   IN CONST VOID             *ExtendedData,
 261   IN UINTN                  ExtendedDataSize
 262   )
 263 {
 264   ASSERT (ExtendedData     != NULL);
 265   ASSERT (ExtendedDataSize != 0);
 266   return EFI_SUCCESS;
 267 }
 268
 269
 270 /**
 271   Reports a status code with full parameters.
 272
 273   The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize
 274   is 0, then an extended data buffer is not reported.  If ExtendedData is not
 275   NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
 276   ExtendedData is assumed not have the standard status code header, so this function
 277   is responsible for allocating a buffer large enough for the standard header and
 278   the extended data passed into this function.  The standard header is filled in
 279   with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a
 280   GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with
 281   an instance specified by Instance and a caller ID specified by CallerId.  If
 282   CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
 283
 284   ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()
 285   is called while processing another any other Report Status Code Library function,
 286   then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
 287
 288   If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
 289   If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
 290
 291   @param  Type              Status code type.
 292   @param  Value             Status code value.
 293   @param  Instance          Status code instance number.
 294   @param  CallerId          Pointer to a GUID that identifies the caller of this
 295                             function.  If this parameter is NULL, then a caller
 296                             ID of gEfiCallerIdGuid is used.
 297   @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.
 298                             If this parameter is NULL, then a the status code
 299                             standard header is filled in with
 300                             gEfiStatusCodeSpecificDataGuid.
 301   @param  ExtendedData      Pointer to the extended data buffer.  This is an
 302                             optional parameter that may be NULL.
 303   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.
 304
 305   @retval  EFI_SUCCESS           The status code was reported.
 306   @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate
 307                                  the extended data section if it was specified.
 308   @retval  EFI_UNSUPPORTED       Report status code is not supported
 309
 310 **/
 311 EFI_STATUS
 312 EFIAPI
 313 ReportStatusCodeEx (
 314   IN EFI_STATUS_CODE_TYPE   Type,
 315   IN EFI_STATUS_CODE_VALUE  Value,
 316   IN UINT32                 Instance,
 317   IN CONST EFI_GUID         *CallerId          OPTIONAL,
 318   IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,
 319   IN CONST VOID             *ExtendedData      OPTIONAL,
 320   IN UINTN                  ExtendedDataSize
 321   )
 322 {
 323   return EFI_SUCCESS;
 324 }
 325
 326
 327 /**
 328   Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
 329
 330   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
 331   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 332
 333   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
 334                   PcdReportStatusCodeProperyMask is set.
 335   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
 336                   PcdReportStatusCodeProperyMask is clear.
 337
 338 **/
 339 BOOLEAN
 340 EFIAPI
 341 ReportProgressCodeEnabled (
 342   VOID
 343   )
 344 {
 345   return FALSE;
 346 }
 347
 348
 349 /**
 350   Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
 351
 352   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
 353   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 354
 355   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
 356                   PcdReportStatusCodeProperyMask is set.
 357   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
 358                   PcdReportStatusCodeProperyMask is clear.
 359
 360 **/
 361 BOOLEAN
 362 EFIAPI
 363 ReportErrorCodeEnabled (
 364   VOID
 365   )
 366 {
 367   return FALSE;
 368 }
 369
 370
 371 /**
 372   Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
 373
 374   This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
 375   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.
 376
 377   @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
 378                   PcdReportStatusCodeProperyMask is set.
 379   @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
 380                   PcdReportStatusCodeProperyMask is clear.
 381
 382 **/
 383 BOOLEAN
 384 EFIAPI
 385 ReportDebugCodeEnabled (
 386   VOID
 387   )
 388 {
 389   return FALSE;
 390 }
 391