FmpDevicePkg: Add FmpDependencyCheck library class and instances

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

diff --git a/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h b/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h
new file mode 100644 (file)
index 0000000..ec380c4
--- /dev/null
+++ b/FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h
@@ -0,0 +1,38 @@
+/** @file\r
+  Fmp Capsule Dependency check functions for Firmware Management Protocol based\r
+  firmware updates.\r
+\r
+  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
+\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef __FMP_DEPENDENCY_CHECK_LIB__\r
+#define __FMP_DEPENDENCY_CHECK_LIB__\r
+\r
+#include <PiDxe.h>\r
+#include <Protocol/FirmwareManagement.h>\r
+\r
+/**\r
+  Check dependency for firmware update.\r
+\r
+  @param[in]  ImageTypeId        Image Type Id.\r
+  @param[in]  Version            New version.\r
+  @param[in]  Dependencies       Fmp dependency.\r
+  @param[in]  DependenciesSize   Size, in bytes, of the Fmp dependency.\r
+\r
+  @retval  TRUE    Dependencies are satisfied.\r
+  @retval  FALSE   Dependencies are unsatisfied or dependency check fails.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CheckFmpDependency (\r
+  IN  EFI_GUID                ImageTypeId,\r
+  IN  UINT32                  Version,\r
+  IN  EFI_FIRMWARE_IMAGE_DEP  *Dependencies,    OPTIONAL\r
+  IN  UINT32                  DependenciesSize\r
+  );\r
+\r
+#endif\r