SignedCapsulePkg/SystemFirmwareUpdateDxe: Fix ECC issues

Make function comments align with functions.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

diff --git a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareUpdateDxe.c b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareUpdateDxe.c
index 8e66aedf627d6d0ad1166cb40980c44dc17849c0..a1ce5b486f7982612b6d34b1792448a3a025e776 100644 (file)
--- a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareUpdateDxe.c
+++ b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareUpdateDxe.c
@@ -59,6 +59,9 @@ ParseUpdateDataFile (
   @param[in]  ConfigData              Points to the component configuration structure.\r
   @param[out] LastAttemptVersion      The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus       The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[in]  ConfigData              Points to the component configuration structure.\r
   @param[out] LastAttemptVersion      The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus       The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r

+  @param[in]  Progress                A function used by the driver to report the progress of the firmware update.\r
+  @param[in]  StartPercentage         The start completion percentage value that may be used to report progress during the flash write operation.\r
+  @param[in]  EndPercentage           The end completion percentage value that may be used to report progress during the flash write operation.\r

 \r
   @retval EFI_SUCCESS             The System Firmware image is updated.\r
   @retval EFI_WRITE_PROTECTED     The flash device is read only.\r
 \r
   @retval EFI_SUCCESS             The System Firmware image is updated.\r
   @retval EFI_WRITE_PROTECTED     The flash device is read only.\r


@@ -117,6 +120,7 @@ PerformUpdate (
   @param[in]  ConfigImageSize         The length of the config file image in bytes.\r
   @param[out] LastAttemptVersion      The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus       The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[in]  ConfigImageSize         The length of the config file image in bytes.\r
   @param[out] LastAttemptVersion      The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus       The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r

+  @param[in]  Progress                A function used by the driver to report the progress of the firmware update.\r

 \r
   @retval EFI_SUCCESS             The System Firmware image is updated.\r
   @retval EFI_WRITE_PROTECTED     The flash device is read only.\r
 \r
   @retval EFI_SUCCESS             The System Firmware image is updated.\r
   @retval EFI_WRITE_PROTECTED     The flash device is read only.\r


@@ -245,6 +249,7 @@ UpdateImage (
   @param[in]  ImageSize          The size of the EDKII system FMP capsule image in bytes.\r
   @param[out] LastAttemptVersion The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus  The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[in]  ImageSize          The size of the EDKII system FMP capsule image in bytes.\r
   @param[out] LastAttemptVersion The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
   @param[out] LastAttemptStatus  The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r

+  @param[in]  Progress           A function used by the driver to report the progress of the firmware update.\r

 \r
   @retval EFI_SUCCESS             EDKII system FMP capsule passes authentication and the System Firmware image is updated.\r
   @retval EFI_SECURITY_VIOLATION  EDKII system FMP capsule fails authentication and the System Firmware image is not updated.\r
 \r
   @retval EFI_SUCCESS             EDKII system FMP capsule passes authentication and the System Firmware image is updated.\r
   @retval EFI_SECURITY_VIOLATION  EDKII system FMP capsule fails authentication and the System Firmware image is not updated.\r