FmpPayloadHeaderLib.c

Go to the documentation of this file.

 
#include <PiDxe.h>
#include <Library/FmpPayloadHeaderLib.h>
 
 
#pragma pack(1)
 
typedef struct {
  UINT32    Signature;
  UINT32    HeaderSize;
  UINT32    FwVersion;
  UINT32    LowestSupportedVersion;
} FMP_PAYLOAD_HEADER;
 
#pragma pack()
 
#define FMP_PAYLOAD_HEADER_SIGNATURE  SIGNATURE_32 ('M', 'S', 'S', '1')
 
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderSize (
  IN  CONST VOID   *Header,
  IN  CONST UINTN  FmpPayloadSize,
  OUT UINT32       *Size
  )
{
  FMP_PAYLOAD_HEADER  *FmpPayloadHeader;
 
  FmpPayloadHeader = NULL;
 
  if ((Header == NULL) || (Size == NULL)) {
    return EFI_INVALID_PARAMETER;
  }
 
  FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
  if (((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader) ||
      ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize) ||
      (FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)))
  {
    return EFI_INVALID_PARAMETER;
  }
 
  if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
    return EFI_INVALID_PARAMETER;
  }
 
  *Size = FmpPayloadHeader->HeaderSize;
  return EFI_SUCCESS;
}
 
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderVersion (
  IN  CONST VOID   *Header,
  IN  CONST UINTN  FmpPayloadSize,
  OUT UINT32       *Version
  )
{
  FMP_PAYLOAD_HEADER  *FmpPayloadHeader;
 
  FmpPayloadHeader = NULL;
 
  if ((Header == NULL) || (Version == NULL)) {
    return EFI_INVALID_PARAMETER;
  }
 
  FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
  if (((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader) ||
      ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize) ||
      (FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)))
  {
    return EFI_INVALID_PARAMETER;
  }
 
  if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
    return EFI_INVALID_PARAMETER;
  }
 
  *Version = FmpPayloadHeader->FwVersion;
  return EFI_SUCCESS;
}
 
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderLowestSupportedVersion (
  IN  CONST VOID   *Header,
  IN  CONST UINTN  FmpPayloadSize,
  OUT UINT32       *LowestSupportedVersion
  )
{
  FMP_PAYLOAD_HEADER  *FmpPayloadHeader;
 
  FmpPayloadHeader = NULL;
 
  if ((Header == NULL) || (LowestSupportedVersion == NULL)) {
    return EFI_INVALID_PARAMETER;
  }
 
  FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
  if (((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader) ||
      ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize) ||
      (FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)))
  {
    return EFI_INVALID_PARAMETER;
  }
 
  if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
    return EFI_INVALID_PARAMETER;
  }
 
  *LowestSupportedVersion = FmpPayloadHeader->LowestSupportedVersion;
  return EFI_SUCCESS;
}