FmpDevicePkg/Include/Library/FmpDependencyDeviceLib.h

   1 /** @file
   2   Provides firmware device specific services to support saving dependency to
   3   firmware device and getting dependency from firmware device.
   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_DEVICE_LIB__
  12 #define __FMP_DEPENDENCY_DEVICE_LIB__
  13
  14 #include <PiDxe.h>
  15 #include <Protocol/FirmwareManagement.h>
  16
  17 /**
  18   Save dependency to Fmp device.
  19
  20   @param[in]  Depex       Fmp dependency.
  21   @param[in]  DepexSize   Size, in bytes, of the Fmp dependency.
  22
  23   @retval  EFI_SUCCESS       Save Fmp dependency succeeds.
  24   @retval  EFI_UNSUPPORTED   Save Fmp dependency is not supported.
  25   @retval  Others            Save Fmp dependency fails.
  26
  27 **/
  28 EFI_STATUS
  29 EFIAPI
  30 SaveFmpDependency (
  31   IN EFI_FIRMWARE_IMAGE_DEP  *Depex,
  32   IN UINT32                  DepexSize
  33   );
  34
  35 /**
  36   Get dependency from the Fmp device.
  37   This caller is responsible for freeing the dependency buffer.
  38
  39   @param[out]  DepexSize   Size, in bytes, of the dependency.
  40
  41   @retval  The pointer to dependency.
  42   @retval  NULL
  43
  44 **/
  45 EFI_FIRMWARE_IMAGE_DEP *
  46 EFIAPI
  47 GetFmpDependency (
  48   OUT UINT32  *DepexSize
  49   );
  50
  51 #endif