MdeModulePkg: Apply uncrustify changes

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / FwVol / Ffs.c

/** @file\r
  FFS file access utilities.\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "DxeMain.h"\r
#include "FwVolDriver.h"\r
\r
/**\r
  Get the FFS file state by checking the highest bit set in the header's state field.\r
\r
  @param  ErasePolarity  Erase polarity attribute of the firmware volume\r
  @param  FfsHeader      Points to the FFS file header\r
\r
  @return FFS File state\r
\r
**/\r
EFI_FFS_FILE_STATE\r
GetFileState (\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
{\r
  EFI_FFS_FILE_STATE  FileState;\r
  UINT8               HighestBit;\r
\r
  FileState = FfsHeader->State;\r
\r
  if (ErasePolarity != 0) {\r
    FileState = (EFI_FFS_FILE_STATE) ~FileState;\r
  }\r
\r
  HighestBit = 0x80;\r
  while (HighestBit != 0 && ((HighestBit & FileState) == 0)) {\r
    HighestBit >>= 1;\r
  }\r
\r
  return (EFI_FFS_FILE_STATE)HighestBit;\r
}\r
\r
/**\r
  Check if a block of buffer is erased.\r
\r
  @param  ErasePolarity  Erase polarity attribute of the firmware volume\r
  @param  InBuffer       The buffer to be checked\r
  @param  BufferSize     Size of the buffer in bytes\r
\r
  @retval TRUE           The block of buffer is erased\r
  @retval FALSE          The block of buffer is not erased\r
\r
**/\r
BOOLEAN\r
IsBufferErased (\r
  IN UINT8  ErasePolarity,\r
  IN VOID   *InBuffer,\r
  IN UINTN  BufferSize\r
  )\r
{\r
  UINTN  Count;\r
  UINT8  EraseByte;\r
  UINT8  *Buffer;\r
\r
  if (ErasePolarity == 1) {\r
    EraseByte = 0xFF;\r
  } else {\r
    EraseByte = 0;\r
  }\r
\r
  Buffer = InBuffer;\r
  for (Count = 0; Count < BufferSize; Count++) {\r
    if (Buffer[Count] != EraseByte) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Verify checksum of the firmware volume header.\r
\r
  @param  FvHeader       Points to the firmware volume header to be checked\r
\r
  @retval TRUE           Checksum verification passed\r
  @retval FALSE          Checksum verification failed\r
\r
**/\r
BOOLEAN\r
VerifyFvHeaderChecksum (\r
  IN EFI_FIRMWARE_VOLUME_HEADER  *FvHeader\r
  )\r
{\r
  UINT16  Checksum;\r
\r
  Checksum = CalculateSum16 ((UINT16 *)FvHeader, FvHeader->HeaderLength);\r
\r
  if (Checksum == 0) {\r
    return TRUE;\r
  } else {\r
    return FALSE;\r
  }\r
}\r
\r
/**\r
  Verify checksum of the FFS file header.\r
\r
  @param  FfsHeader      Points to the FFS file header to be checked\r
\r
  @retval TRUE           Checksum verification passed\r
  @retval FALSE          Checksum verification failed\r
\r
**/\r
BOOLEAN\r
VerifyHeaderChecksum (\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
{\r
  UINT8  HeaderChecksum;\r
\r
  if (IS_FFS_FILE2 (FfsHeader)) {\r
    HeaderChecksum = CalculateSum8 ((UINT8 *)FfsHeader, sizeof (EFI_FFS_FILE_HEADER2));\r
  } else {\r
    HeaderChecksum = CalculateSum8 ((UINT8 *)FfsHeader, sizeof (EFI_FFS_FILE_HEADER));\r
  }\r
\r
  HeaderChecksum = (UINT8)(HeaderChecksum - FfsHeader->State - FfsHeader->IntegrityCheck.Checksum.File);\r
\r
  if (HeaderChecksum == 0) {\r
    return TRUE;\r
  } else {\r
    return FALSE;\r
  }\r
}\r
\r
/**\r
  Check if it's a valid FFS file header.\r
\r
  @param  ErasePolarity  Erase polarity attribute of the firmware volume\r
  @param  FfsHeader      Points to the FFS file header to be checked\r
  @param  FileState      FFS file state to be returned\r
\r
  @retval TRUE           Valid FFS file header\r
  @retval FALSE          Invalid FFS file header\r
\r
**/\r
BOOLEAN\r
IsValidFfsHeader (\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader,\r
  OUT EFI_FFS_FILE_STATE  *FileState\r
  )\r
{\r
  *FileState = GetFileState (ErasePolarity, FfsHeader);\r
\r
  switch (*FileState) {\r
    case EFI_FILE_HEADER_VALID:\r
    case EFI_FILE_DATA_VALID:\r
    case EFI_FILE_MARKED_FOR_UPDATE:\r
    case EFI_FILE_DELETED:\r
      //\r
      // Here we need to verify header checksum\r
      //\r
      return VerifyHeaderChecksum (FfsHeader);\r
\r
    case EFI_FILE_HEADER_CONSTRUCTION:\r
    case EFI_FILE_HEADER_INVALID:\r
    default:\r
      return FALSE;\r
  }\r
}\r
\r
/**\r
  Check if it's a valid FFS file.\r
  Here we are sure that it has a valid FFS file header since we must call IsValidFfsHeader() first.\r
\r
  @param  ErasePolarity  Erase polarity attribute of the firmware volume\r
  @param  FfsHeader      Points to the FFS file to be checked\r
\r
  @retval TRUE           Valid FFS file\r
  @retval FALSE          Invalid FFS file\r
\r
**/\r
BOOLEAN\r
IsValidFfsFile (\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
{\r
  EFI_FFS_FILE_STATE  FileState;\r
  UINT8               DataCheckSum;\r
\r
  FileState = GetFileState (ErasePolarity, FfsHeader);\r
  switch (FileState) {\r
    case EFI_FILE_DELETED:\r
    case EFI_FILE_DATA_VALID:\r
    case EFI_FILE_MARKED_FOR_UPDATE:\r
      DataCheckSum = FFS_FIXED_CHECKSUM;\r
      if ((FfsHeader->Attributes & FFS_ATTRIB_CHECKSUM) == FFS_ATTRIB_CHECKSUM) {\r
        if (IS_FFS_FILE2 (FfsHeader)) {\r
          DataCheckSum = CalculateCheckSum8 ((CONST UINT8 *)FfsHeader + sizeof (EFI_FFS_FILE_HEADER2), FFS_FILE2_SIZE (FfsHeader) - sizeof (EFI_FFS_FILE_HEADER2));\r
        } else {\r
          DataCheckSum = CalculateCheckSum8 ((CONST UINT8 *)FfsHeader + sizeof (EFI_FFS_FILE_HEADER), FFS_FILE_SIZE (FfsHeader) - sizeof (EFI_FFS_FILE_HEADER));\r
        }\r
      }\r
\r
      if (FfsHeader->IntegrityCheck.Checksum.File == DataCheckSum) {\r
        return TRUE;\r
      }\r
\r
    default:\r
      return FALSE;\r
  }\r
}\r