X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=FmpDevicePkg%2FPrivateInclude%2FLibrary%2FFmpPayloadHeaderLib.h;fp=FmpDevicePkg%2FPrivateInclude%2FLibrary%2FFmpPayloadHeaderLib.h;h=24afd5e29954414a28e3bf07379b5ea0300dac59;hp=0000000000000000000000000000000000000000;hb=c40f7cc7fd75e5fff9915ceedb1c10584c98e581;hpb=67c1e5ee6eaf592e0331bc06df41ec4c21b22a07

diff --git a/FmpDevicePkg/PrivateInclude/Library/FmpPayloadHeaderLib.h b/FmpDevicePkg/PrivateInclude/Library/FmpPayloadHeaderLib.h
new file mode 100644
index 0000000000..24afd5e299
--- /dev/null
+++ b/FmpDevicePkg/PrivateInclude/Library/FmpPayloadHeaderLib.h
@@ -0,0 +1,83 @@
+/** @file
+  Provides services to retrieve values from a capsule's FMP Payload Header.
+  The structure is not included in the library class.  Instead, services are
+  provided to retrieve information from the FMP Payload Header.  If information
+  is added to the FMP Payload Header, then new services may be added to this
+  library class to retrieve the new information.
+
+  Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>
+  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef _FMP_PAYLOAD_HEADER_LIB_H__
+#define _FMP_PAYLOAD_HEADER_LIB_H__
+
+/**
+  Returns the FMP Payload Header size in bytes.
+
+  @param[in]  Header          FMP Payload Header to evaluate
+  @param[in]  FmpPayloadSize  Size of FMP payload
+  @param[out] Size            The size, in bytes, of the FMP Payload Header.
+
+  @retval EFI_SUCCESS            The firmware version was returned.
+  @retval EFI_INVALID_PARAMETER  Header is NULL.
+  @retval EFI_INVALID_PARAMETER  Size is NULL.
+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.
+
+**/
+EFI_STATUS
+EFIAPI
+GetFmpPayloadHeaderSize (
+  IN  CONST VOID   *Header,
+  IN  CONST UINTN  FmpPayloadSize,
+  OUT UINT32       *Size
+  );
+
+/**
+  Returns the version described in the FMP Payload Header.
+
+  @param[in]  Header          FMP Payload Header to evaluate
+  @param[in]  FmpPayloadSize  Size of FMP payload
+  @param[out] Version         The firmware version described in the FMP Payload
+                              Header.
+
+  @retval EFI_SUCCESS            The firmware version was returned.
+  @retval EFI_INVALID_PARAMETER  Header is NULL.
+  @retval EFI_INVALID_PARAMETER  Version is NULL.
+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.
+
+**/
+EFI_STATUS
+EFIAPI
+GetFmpPayloadHeaderVersion (
+  IN  CONST VOID   *Header,
+  IN  CONST UINTN  FmpPayloadSize,
+  OUT UINT32       *Version
+  );
+
+/**
+  Returns the lowest supported version described in the FMP Payload Header.
+
+  @param[in]  Header                  FMP Payload Header to evaluate
+  @param[in]  FmpPayloadSize          Size of FMP payload
+  @param[out] LowestSupportedVersion  The lowest supported version described in
+                                      the FMP Payload Header.
+
+  @retval EFI_SUCCESS            The lowest support version was returned.
+  @retval EFI_INVALID_PARAMETER  Header is NULL.
+  @retval EFI_INVALID_PARAMETER  LowestSupportedVersion is NULL.
+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.
+
+**/
+EFI_STATUS
+EFIAPI
+GetFmpPayloadHeaderLowestSupportedVersion (
+  IN  CONST VOID    *Header,
+  IN  CONST UINTN   FmpPayloadSize,
+  OUT UINT32        *LowestSupportedVersion
+  );
+
+#endif