FmpDevicePkg: Add Last Attempt Status support to dependency libs

[mirror_edk2.git] / FmpDevicePkg / Include / Library / FmpDependencyCheckLib.h

diff --git a/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h b/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h
index ec380c4947bda61f6313c200819ca49006f09214..785bda9401e6bea2545b38a3367f5b1b73ff04d7 100644 (file)
--- a/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h
+++ b/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h
@@ -2,6 +2,7 @@
   Fmp Capsule Dependency check functions for Firmware Management Protocol based\r
   firmware updates.\r
 \r
+  Copyright (c) Microsoft Corporation.<BR>\r
   Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -21,6 +22,10 @@
   @param[in]  Version            New version.\r
   @param[in]  Dependencies       Fmp dependency.\r
   @param[in]  DependenciesSize   Size, in bytes, of the Fmp dependency.\r
+  @param[out] LastAttemptStatus  An optional pointer to a UINT32 that holds the\r
+                                 last attempt status to report back to the caller.\r
+                                 This function will set the value to LAST_ATTEMPT_STATUS_SUCCESS\r
+                                 if an error code is not set.\r
 \r
   @retval  TRUE    Dependencies are satisfied.\r
   @retval  FALSE   Dependencies are unsatisfied or dependency check fails.\r
@@ -32,7 +37,8 @@ CheckFmpDependency (
   IN  EFI_GUID                ImageTypeId,\r
   IN  UINT32                  Version,\r
   IN  EFI_FIRMWARE_IMAGE_DEP  *Dependencies,    OPTIONAL\r
-  IN  UINT32                  DependenciesSize\r
+  IN  UINT32                  DependenciesSize,\r
+  OUT UINT32                  *LastAttemptStatus OPTIONAL\r
   );\r
 \r
 #endif\r