]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/ReportStatusCodeLib.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Library / ReportStatusCodeLib.h
index 3924fa20e8dcaf5076c407a117c4dc149fa59701..e60aff01df5f7354fbd19ce0424a2d33a108dd8b 100644 (file)
@@ -1,9 +1,9 @@
 /** @file\r
   Provides services to log status code records.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
 The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php.\r
 \r
@@ -29,21 +29,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Converts a status code to an 8-bit POST code value.\r
 \r
-  Converts the status code specified by CodeType and Value to an 8-bit POST code \r
-  and returns the 8-bit POST code in PostCode.  If CodeType is an \r
-  EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode \r
-  are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits \r
-  24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.  \r
+  Converts the status code specified by CodeType and Value to an 8-bit POST code\r
+  and returns the 8-bit POST code in PostCode.  If CodeType is an\r
+  EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode\r
+  are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits\r
+  24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.\r
 \r
   If PostCode is NULL, then ASSERT().\r
 \r
   @param  CodeType  The type of status code being converted.\r
   @param  Value     The status code value being converted.\r
-  @param  PostCode  A pointer to the 8-bit POST code value to return. \r
+  @param  PostCode  A pointer to the 8-bit POST code value to return.\r
 \r
-  @retval  TRUE   The status code specified by CodeType and Value was converted \r
+  @retval  TRUE   The status code specified by CodeType and Value was converted\r
                   to an 8-bit POST code and returned in PostCode.\r
-  @retval  FALSE  The status code specified by CodeType and Value could not be \r
+  @retval  FALSE  The status code specified by CodeType and Value could not be\r
                   converted to an 8-bit POST code value.\r
 \r
 **/\r
@@ -60,15 +60,15 @@ CodeTypeToPostCode (
   Extracts ASSERT() information from a status code structure.\r
 \r
   Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r
-  arguments specified by Filename, Description, and LineNumber.  If CodeType is \r
-  an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and \r
-  Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract \r
-  Filename, Description, and LineNumber from the optional data area of the \r
-  status code buffer specified by Data.  The optional data area of Data contains \r
-  a Null-terminated ASCII string for the FileName, followed by a Null-terminated \r
-  ASCII string for the Description, followed by a 32-bit LineNumber.  If the \r
-  ASSERT() information could be extracted from Data, then return TRUE.  \r
-  Otherwise, FALSE is returned.  \r
+  arguments specified by Filename, Description, and LineNumber.  If CodeType is\r
+  an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and\r
+  Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract\r
+  Filename, Description, and LineNumber from the optional data area of the\r
+  status code buffer specified by Data.  The optional data area of Data contains\r
+  a Null-terminated ASCII string for the FileName, followed by a Null-terminated\r
+  ASCII string for the Description, followed by a 32-bit LineNumber.  If the\r
+  ASSERT() information could be extracted from Data, then return TRUE.\r
+  Otherwise, FALSE is returned.\r
 \r
   If Data is NULL, then ASSERT().\r
   If Filename is NULL, then ASSERT().\r
@@ -77,15 +77,15 @@ CodeTypeToPostCode (
 \r
   @param  CodeType     The type of status code being converted.\r
   @param  Value        The status code value being converted.\r
-  @param  Data         The pointer to status code data buffer. \r
+  @param  Data         The pointer to status code data buffer.\r
   @param  Filename     The pointer to the source file name that generated the ASSERT().\r
   @param  Description  The pointer to the description of the ASSERT().\r
   @param  LineNumber   The pointer to source line number that generated the ASSERT().\r
 \r
-  @retval  TRUE   The status code specified by CodeType, Value, and Data was \r
-                  converted ASSERT() arguments specified by Filename, Description, \r
+  @retval  TRUE   The status code specified by CodeType, Value, and Data was\r
+                  converted ASSERT() arguments specified by Filename, Description,\r
                   and LineNumber.\r
-  @retval  FALSE  The status code specified by CodeType, Value, and Data could \r
+  @retval  FALSE  The status code specified by CodeType, Value, and Data could\r
                   not be converted to ASSERT() arguments.\r
 \r
 **/\r
@@ -93,8 +93,8 @@ BOOLEAN
 EFIAPI\r
 ReportStatusCodeExtractAssertInfo (\r
   IN EFI_STATUS_CODE_TYPE        CodeType,\r
-  IN EFI_STATUS_CODE_VALUE       Value,  \r
-  IN CONST EFI_STATUS_CODE_DATA  *Data, \r
+  IN EFI_STATUS_CODE_VALUE       Value,\r
+  IN CONST EFI_STATUS_CODE_DATA  *Data,\r
   OUT CHAR8                      **Filename,\r
   OUT CHAR8                      **Description,\r
   OUT UINT32                     *LineNumber\r
@@ -104,13 +104,13 @@ ReportStatusCodeExtractAssertInfo (
 /**\r
   Extracts DEBUG() information from a status code structure.\r
 \r
-  Converts the status code specified by Data to the DEBUG() arguments specified \r
-  by ErrorLevel, Marker, and Format.  If type GUID in Data is \r
-  EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and \r
-  Format from the optional data area of the status code buffer specified by Data.  \r
-  The optional data area of Data contains a 32-bit ErrorLevel followed by Marker \r
-  which is 12 UINTN parameters, followed by a Null-terminated ASCII string for \r
-  the Format.  If the DEBUG() information could be extracted from Data, then \r
+  Converts the status code specified by Data to the DEBUG() arguments specified\r
+  by ErrorLevel, Marker, and Format.  If type GUID in Data is\r
+  EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and\r
+  Format from the optional data area of the status code buffer specified by Data.\r
+  The optional data area of Data contains a 32-bit ErrorLevel followed by Marker\r
+  which is 12 UINTN parameters, followed by a Null-terminated ASCII string for\r
+  the Format.  If the DEBUG() information could be extracted from Data, then\r
   return TRUE.  Otherwise, FALSE is returned.\r
 \r
   If Data is NULL, then ASSERT().\r
@@ -118,22 +118,22 @@ ReportStatusCodeExtractAssertInfo (
   If Marker is NULL, then ASSERT().\r
   If Format is NULL, then ASSERT().\r
 \r
-  @param  Data        The pointer to status code data buffer. \r
+  @param  Data        The pointer to status code data buffer.\r
   @param  ErrorLevel  The pointer to error level mask for a debug message.\r
   @param  Marker      The pointer to the variable argument list associated with Format.\r
-  @param  Format      The pointer to a Null-terminated ASCII format string of a \r
+  @param  Format      The pointer to a Null-terminated ASCII format string of a\r
                       debug message.\r
 \r
-  @retval  TRUE   The status code specified by Data was converted DEBUG() arguments \r
+  @retval  TRUE   The status code specified by Data was converted DEBUG() arguments\r
                   specified by ErrorLevel, Marker, and Format.\r
-  @retval  FALSE  The status code specified by Data could not be converted to \r
+  @retval  FALSE  The status code specified by Data could not be converted to\r
                   DEBUG() arguments.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
 ReportStatusCodeExtractDebugInfo (\r
-  IN CONST EFI_STATUS_CODE_DATA  *Data, \r
+  IN CONST EFI_STATUS_CODE_DATA  *Data,\r
   OUT UINT32                     *ErrorLevel,\r
   OUT BASE_LIST                  *Marker,\r
   OUT CHAR8                      **Format\r
@@ -143,20 +143,20 @@ ReportStatusCodeExtractDebugInfo (
 /**\r
   Reports a status code.\r
 \r
-  Reports the status code specified by the parameters Type and Value.  Status \r
-  code also require an instance, caller ID, and extended data.  This function \r
-  passed in a zero instance, NULL extended data, and a caller ID of \r
-  gEfiCallerIdGuid, which is the GUID for the module.  \r
-  \r
-  ReportStatusCode()must actively prevent recursion.  If ReportStatusCode() \r
+  Reports the status code specified by the parameters Type and Value.  Status\r
+  code also require an instance, caller ID, and extended data.  This function\r
+  passed in a zero instance, NULL extended data, and a caller ID of\r
+  gEfiCallerIdGuid, which is the GUID for the module.\r
+\r
+  ReportStatusCode()must actively prevent recursion.  If ReportStatusCode()\r
   is called while processing another any other Report Status Code Library function,\r
   then ReportStatusCode() must return immediately.\r
 \r
-  @param  Type   Status code type. \r
+  @param  Type   Status code type.\r
   @param  Value  Status code value.\r
 \r
   @retval  EFI_SUCCESS       The status code was reported.\r
-  @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a \r
+  @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a\r
                              device error.\r
   @retval  EFI_UNSUPPORTED   The report status code is not supported.\r
 \r
@@ -172,26 +172,26 @@ ReportStatusCode (
 /**\r
   Reports a status code with a Device Path Protocol as the extended data.\r
 \r
-  Allocates and fills in the extended data section of a status code with the \r
-  Device Path Protocol specified by DevicePath.  This function is responsible \r
-  for allocating a buffer large enough for the standard header and the device \r
+  Allocates and fills in the extended data section of a status code with the\r
+  Device Path Protocol specified by DevicePath.  This function is responsible\r
+  for allocating a buffer large enough for the standard header and the device\r
   path.  The standard header is filled in with an implementation dependent GUID.\r
   The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid.\r
 \r
-  ReportStatusCodeWithDevicePath()must actively prevent recursion.  If \r
-  ReportStatusCodeWithDevicePath() is called while processing another any other \r
-  Report Status Code Library function, then ReportStatusCodeWithDevicePath() \r
+  ReportStatusCodeWithDevicePath()must actively prevent recursion.  If\r
+  ReportStatusCodeWithDevicePath() is called while processing another any other\r
+  Report Status Code Library function, then ReportStatusCodeWithDevicePath()\r
   must return EFI_DEVICE_ERROR immediately.\r
 \r
   If DevicePath is NULL, then ASSERT().\r
 \r
-  @param  Type        The status code type. \r
+  @param  Type        The status code type.\r
   @param  Value       The status code value.\r
   @param  DevicePath  The pointer to the Device Path Protocol to be reported.\r
 \r
-  @retval  EFI_SUCCESS           The status code was reported with the extended \r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
                                  data specified by DevicePath.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
                                  extended data section.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r
@@ -210,32 +210,32 @@ ReportStatusCodeWithDevicePath (
 /**\r
   Reports a status code with an extended data buffer.\r
 \r
-  Allocates and fills in the extended data section of a status code with the \r
-  extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData \r
-  is assumed to be one of the data structures specified in Related Definitions.  \r
-  These data structure do not have the standard header, so this function is \r
-  responsible for allocating a buffer large enough for the standard header and \r
-  the extended data passed into this function.  The standard header is filled \r
-  in with an implementation dependent GUID.  The status code is reported \r
+  Allocates and fills in the extended data section of a status code with the\r
+  extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData\r
+  is assumed to be one of the data structures specified in Related Definitions.\r
+  These data structure do not have the standard header, so this function is\r
+  responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled\r
+  in with an implementation dependent GUID.  The status code is reported\r
   with a zero instance and a caller ID of gEfiCallerIdGuid.\r
 \r
-  ReportStatusCodeWithExtendedData()must actively prevent recursion.  If \r
-  ReportStatusCodeWithExtendedData() is called while processing another any other \r
-  Report Status Code Library function, then ReportStatusCodeWithExtendedData() \r
+  ReportStatusCodeWithExtendedData()must actively prevent recursion.  If\r
+  ReportStatusCodeWithExtendedData() is called while processing another any other\r
+  Report Status Code Library function, then ReportStatusCodeWithExtendedData()\r
   must return EFI_DEVICE_ERROR immediately.\r
 \r
   If ExtendedData is NULL, then ASSERT().\r
   If ExtendedDataSize is 0, then ASSERT().\r
 \r
-  @param  Type              The status code type. \r
+  @param  Type              The status code type.\r
   @param  Value             The status code value.\r
   @param  ExtendedData      The pointer to the extended data buffer to be reported.\r
-  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to \r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to\r
                             be reported.\r
 \r
-  @retval  EFI_SUCCESS           The status code was reported with the extended \r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
                                  data specified by ExtendedData and ExtendedDataSize.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
                                  extended data section.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r
@@ -255,39 +255,39 @@ ReportStatusCodeWithExtendedData (
 /**\r
   Reports a status code with full parameters.\r
 \r
-  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize \r
-  is 0, then an extended data buffer is not reported.  If ExtendedData is not \r
-  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.  \r
-  ExtendedData is assumed not have the standard status code header, so this function \r
-  is responsible for allocating a buffer large enough for the standard header and \r
-  the extended data passed into this function.  The standard header is filled in \r
-  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a \r
-  GUID of gEfiStatusCodeSpecificDataGuid is used.  The status code is reported with \r
-  an instance specified by Instance and a caller ID specified by CallerId.  If \r
+  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize\r
+  is 0, then an extended data buffer is not reported.  If ExtendedData is not\r
+  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
+  ExtendedData is assumed not have the standard status code header, so this function\r
+  is responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled in\r
+  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a\r
+  GUID of gEfiStatusCodeSpecificDataGuid is used.  The status code is reported with\r
+  an instance specified by Instance and a caller ID specified by CallerId.  If\r
   CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
 \r
-  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx() \r
-  is called while processing another any other Report Status Code Library function, \r
+  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()\r
+  is called while processing another any other Report Status Code Library function,\r
   then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
 \r
   If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
   If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
 \r
-  @param  Type              The status code type. \r
+  @param  Type              The status code type.\r
   @param  Value             The status code value.\r
   @param  Instance          The status code instance number.\r
-  @param  CallerId          The pointer to a GUID that identifies the caller of this \r
-                            function.  If this parameter is NULL, then a caller \r
+  @param  CallerId          The pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
                             ID of gEfiCallerIdGuid is used.\r
-  @param  ExtendedDataGuid  The pointer to the GUID for the extended data buffer.  \r
-                            If this parameter is NULL, then a the status code \r
+  @param  ExtendedDataGuid  The pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
                             standard header is filled in with an implementation dependent GUID.\r
-  @param  ExtendedData      The pointer to the extended data buffer.  This is an \r
+  @param  ExtendedData      The pointer to the extended data buffer.  This is an\r
                             optional parameter that may be NULL.\r
   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
 \r
   @retval  EFI_SUCCESS           The status code was reported.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate\r
                                  the extended data section if it was specified.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r
@@ -310,12 +310,12 @@ ReportStatusCodeEx (
 /**\r
   Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r
 \r
-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED \r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED\r
   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.\r
 \r
-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of \r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is set.\r
-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of \r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is clear.\r
 \r
 **/\r
@@ -329,12 +329,12 @@ ReportProgressCodeEnabled (
 /**\r
   Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
 \r
-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED \r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED\r
   bit of PcdReportStatusCodeProperyMask is set.  Otherwise, FALSE is returned.\r
 \r
-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is set.\r
-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is clear.\r
 \r
 **/\r
@@ -348,12 +348,12 @@ ReportErrorCodeEnabled (
 /**\r
   Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r
 \r
-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED \r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED\r
   bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.\r
 \r
-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of \r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is set.\r
-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of \r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
                   PcdReportStatusCodeProperyMask is clear.\r
 \r
 **/\r
@@ -367,11 +367,11 @@ ReportDebugCodeEnabled (
 /**\r
   Reports a status code with minimal parameters if the status code type is enabled.\r
 \r
-  If the status code type specified by Type is enabled in \r
-  PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type \r
+  If the status code type specified by Type is enabled in\r
+  PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type\r
   and Value.\r
 \r
-  @param  Type   The status code type. \r
+  @param  Type   The status code type.\r
   @param  Value  The status code value.\r
 \r
   @retval  EFI_SUCCESS       The status code was reported.\r
@@ -390,20 +390,20 @@ ReportDebugCodeEnabled (
 \r
 \r
 /**\r
-  Reports a status code with a Device Path Protocol as the extended data if the \r
+  Reports a status code with a Device Path Protocol as the extended data if the\r
   status code type is enabled.\r
 \r
-  If the status code type specified by Type is enabled in \r
-  PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() \r
+  If the status code type specified by Type is enabled in\r
+  PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath()\r
   passing in Type, Value, and DevicePath.\r
 \r
-  @param  Type        The status code type. \r
+  @param  Type        The status code type.\r
   @param  Value       The status code value.\r
   @param  DevicePath  Pointer to the Device Path Protocol to be reported.\r
 \r
-  @retval  EFI_SUCCESS           The status code was reported with the extended \r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
                                  data specified by DevicePath.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
                                  extended data section.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r
@@ -421,22 +421,22 @@ ReportDebugCodeEnabled (
 \r
 \r
 /**\r
-  Reports a status code with an extended data buffer if the status code type \r
+  Reports a status code with an extended data buffer if the status code type\r
   is enabled.\r
 \r
-  If the status code type specified by Type is enabled in \r
-  PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() \r
+  If the status code type specified by Type is enabled in\r
+  PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData()\r
   passing in Type, Value, ExtendedData, and ExtendedDataSize.\r
 \r
-  @param  Type              The status code type. \r
+  @param  Type              The status code type.\r
   @param  Value             The status code value.\r
   @param  ExtendedData      The pointer to the extended data buffer to be reported.\r
   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to\r
                             be reported.\r
 \r
-  @retval  EFI_SUCCESS           The status code was reported with the extended \r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
                                  data specified by ExtendedData and ExtendedDataSize.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
                                  extended data section.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r
@@ -455,25 +455,25 @@ ReportDebugCodeEnabled (
 /**\r
   Reports a status code specifying all parameters if the status code type is enabled.\r
 \r
-  If the status code type specified by Type is enabled in \r
-  PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, \r
+  If the status code type specified by Type is enabled in\r
+  PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type,\r
   Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, and ExtendedDataSize.\r
 \r
-  @param  Type              The status code type. \r
+  @param  Type              The status code type.\r
   @param  Value             The status code value.\r
   @param  Instance          The status code instance number.\r
-  @param  CallerId          The pointer to a GUID that identifies the caller of this \r
-                            function.  If this parameter is NULL, then a caller \r
+  @param  CallerId          The pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
                             ID of gEfiCallerIdGuid is used.\r
-  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.  \r
-                            If this parameter is NULL, then a the status code \r
+  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
                             standard header is filled in with an implementation dependent GUID.\r
-  @param  ExtendedData      Pointer to the extended data buffer.  This is an \r
+  @param  ExtendedData      Pointer to the extended data buffer.  This is an\r
                             optional parameter that may be NULL.\r
   @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
 \r
   @retval  EFI_SUCCESS           The status code was reported.\r
-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the \r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
                                  extended data section if it was specified.\r
   @retval  EFI_UNSUPPORTED       The report status code is not supported.\r
   @retval  EFI_DEVICE_ERROR      A call to a Report Status Code Library function\r