commit 004ce0ab041409d6c39b7d49b69c816ea0cddd70
author Michael Kubacki <michael.kubacki@microsoft.com> Tue Oct 20 07:59:37 2020 +0800
committer mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Wed Oct 28 06:05:52 2020 +0000
tree 5fb99cc81acc162b1bd1fecb472425a226611352
parent 5550f4d33b64abc989ec6597ed6a19712b915c63

FmpDevicePkg/FmpDxe: Improve set image path Last Attempt Status granularity

Increases the level of granularity for Last Attempt Status codes
returned from SetTheImage() in FmpDxe. This allows better
identification of the error that occurred in the set image
operation using Last Attempt Status codes.

Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Acked-by: Liming Gao <gaoliming@byosoft.com.cn>
Reviewed-by: Wei6 Xu <wei6.xu@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>

FmpDevicePkg/FmpDxe/FmpDxe.c

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c b/FmpDevicePkg/FmpDxe/FmpDxe.c
index bc11faa..b7fd9c9 100644
--- a/FmpDevicePkg/FmpDxe/FmpDxe.c
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
@@ -1138,6 +1138,7 @@
   if (This == NULL) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - This is NULL.\n", mImageIdName));

     Status = EFI_INVALID_PARAMETER;

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_PROTOCOL_ARG_MISSING;

     goto cleanup;

   }

 

@@ -1163,6 +1164,7 @@
   //

   if (Private->FmpDeviceLocked) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - Device is already locked.  Can't update.\n", mImageIdName));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_DEVICE_LOCKED;

     Status = EFI_UNSUPPORTED;

     goto cleanup;

   }

@@ -1170,12 +1172,9 @@
   //

   // Call check image to verify the image

   //

-  Status = CheckTheImage (This, ImageIndex, Image, ImageSize, &Updateable);

+  Status = CheckTheImageInternal (This, ImageIndex, Image, ImageSize, &Updateable, &LastAttemptStatus);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - Check The Image failed with %r.\n", mImageIdName, Status));

-    if (Status == EFI_SECURITY_VIOLATION) {

-      LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR;

-    }

     goto cleanup;

   }

 

@@ -1191,6 +1190,7 @@
   FmpHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, DependenciesSize, &FmpPayloadSize );

   if (FmpHeader == NULL) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetFmpHeader failed.\n", mImageIdName));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_FMP_HEADER;

     Status = EFI_ABORTED;

     goto cleanup;

   }

@@ -1218,6 +1218,7 @@
 

   if (Progress == NULL) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - Invalid progress callback\n", mImageIdName));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_PROGRESS_CALLBACK_ERROR;

     Status = EFI_INVALID_PARAMETER;

     goto cleanup;

   }

@@ -1238,6 +1239,7 @@
   Status = CheckSystemPower (&BooleanValue);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - CheckSystemPower - API call failed %r.\n", mImageIdName, Status));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_POWER_API;

     goto cleanup;

   }

   if (!BooleanValue) {

@@ -1258,10 +1260,12 @@
   Status = CheckSystemThermal (&BooleanValue);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - CheckSystemThermal - API call failed %r.\n", mImageIdName, Status));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_SYS_THERMAL_API;

     goto cleanup;

   }

   if (!BooleanValue) {

     Status = EFI_ABORTED;

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_THERMAL;

     DEBUG (

       (DEBUG_ERROR,

       "FmpDxe(%s): SetTheImage() - CheckSystemThermal - returned False.  Update not allowed due to System Thermal.\n", mImageIdName)

@@ -1277,10 +1281,12 @@
   Status = CheckSystemEnvironment (&BooleanValue);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - CheckSystemEnvironment - API call failed %r.\n", mImageIdName, Status));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_SYS_ENV_API;

     goto cleanup;

   }

   if (!BooleanValue) {

     Status = EFI_ABORTED;

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_SYSTEM_ENV;

     DEBUG (

       (DEBUG_ERROR,

       "FmpDxe(%s): SetTheImage() - CheckSystemEnvironment - returned False.  Update not allowed due to System Environment.\n", mImageIdName)

@@ -1302,12 +1308,14 @@
   Status = GetFmpPayloadHeaderSize (FmpHeader, FmpPayloadSize, &FmpHeaderSize);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetFmpPayloadHeaderSize failed %r.\n", mImageIdName, Status));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_FMP_HEADER_SIZE;

     goto cleanup;

   }

 

   AllHeaderSize = GetAllHeaderSize ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, FmpHeaderSize + DependenciesSize);

   if (AllHeaderSize == 0) {

     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetAllHeaderSize failed.\n", mImageIdName));

+    LastAttemptStatus = LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_ALL_HEADER_SIZE;

     Status = EFI_ABORTED;

     goto cleanup;

   }

@@ -1372,6 +1380,7 @@
   mProgressFunc = NULL;

 

   if (Private != NULL) {

+    DEBUG ((DEBUG_INFO, "FmpDxe(%s): SetTheImage() LastAttemptStatus: %u.\n", mImageIdName, LastAttemptStatus));

     SetLastAttemptStatusInVariable (Private, LastAttemptStatus);

   }