FmpDevicePkg/Include/Library/FmpDependencyCheckLib.h

   1 /** @file
   2   Fmp Capsule Dependency check functions for Firmware Management Protocol based
   3   firmware updates.
   4
   5   Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __FMP_DEPENDENCY_CHECK_LIB__
  12 #define __FMP_DEPENDENCY_CHECK_LIB__
  13
  14 #include <PiDxe.h>
  15 #include <Protocol/FirmwareManagement.h>
  16
  17 /**
  18   Check dependency for firmware update.
  19
  20   @param[in]  ImageTypeId        Image Type Id.
  21   @param[in]  Version            New version.
  22   @param[in]  Dependencies       Fmp dependency.
  23   @param[in]  DependenciesSize   Size, in bytes, of the Fmp dependency.
  24
  25   @retval  TRUE    Dependencies are satisfied.
  26   @retval  FALSE   Dependencies are unsatisfied or dependency check fails.
  27
  28 **/
  29 BOOLEAN
  30 EFIAPI
  31 CheckFmpDependency (
  32   IN  EFI_GUID                ImageTypeId,
  33   IN  UINT32                  Version,
  34   IN  EFI_FIRMWARE_IMAGE_DEP  *Dependencies,    OPTIONAL
  35   IN  UINT32                  DependenciesSize
  36   );
  37
  38 #endif