Check In tool source code based on Build tool project revision r1655.

[mirror_edk2.git] / BaseTools / Source / C / Common / FirmwareVolumeBufferLib.h

/** @file\r
\r
Copyright (c) 1999 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  FirmwareVolumeBufferLib.h\r
  \r
Abstract:\r
\r
  EFI Firmware Volume routines which work on a Fv image in buffers.\r
\r
**/\r
\r
#ifndef FirmwareVolumeBuffer_h_INCLUDED\r
#define FirmwareVolumeBuffer_h_INCLUDED\r
\r
#include "Common/UefiBaseTypes.h"\r
#include "Common/PiFirmwareFile.h"\r
#include "Common/PiFirmwareVolume.h"\r
\r
EFI_STATUS\r
FvBufAddFile (\r
  IN OUT VOID *Fv,\r
  IN VOID *File\r
  );\r
\r
EFI_STATUS\r
FvBufAddFileWithExtend (\r
  IN OUT VOID **Fv,\r
  IN VOID *File\r
  );\r
\r
EFI_STATUS\r
FvBufAddVtfFile (\r
  IN OUT VOID *Fv,\r
  IN VOID *File\r
  );\r
\r
EFI_STATUS\r
FvBufChecksumFile (\r
  IN OUT VOID *FfsFile\r
  );\r
\r
EFI_STATUS\r
FvBufChecksumHeader (\r
  IN OUT VOID *Fv\r
  );\r
\r
EFI_STATUS\r
FvBufClearAllFiles (\r
  IN OUT VOID *Fv\r
  );\r
\r
VOID\r
FvBufCompact3ByteSize (\r
  OUT VOID* SizeDest,\r
  IN UINT32 Size\r
  );\r
\r
EFI_STATUS\r
FvBufCountSections (\r
  IN VOID* FfsFile,\r
  IN UINTN* Count\r
  );\r
\r
EFI_STATUS\r
FvBufDuplicate (\r
  IN VOID *SourceFv,\r
  IN OUT VOID **DestinationFv\r
  );\r
\r
UINT32\r
FvBufExpand3ByteSize (\r
  IN VOID* Size\r
  );\r
\r
EFI_STATUS\r
FvBufExtend (\r
  IN VOID **Fv,\r
  IN UINTN Size\r
  );\r
\r
EFI_STATUS\r
FvBufFindFileByName (\r
  IN VOID *Fv,\r
  IN EFI_GUID *Name,\r
  OUT VOID **File\r
  );\r
\r
EFI_STATUS\r
FvBufFindFileByType (\r
  IN VOID *Fv,\r
  IN EFI_FV_FILETYPE Type,\r
  OUT VOID **File\r
  );\r
\r
EFI_STATUS\r
FvBufFindNextFile (\r
  IN VOID *Fv,\r
  IN OUT UINTN *Key,\r
  OUT VOID **File\r
  );\r
\r
EFI_STATUS\r
FvBufFindNextSection (\r
  IN VOID *SectionsStart,\r
  IN UINTN TotalSectionsSize,\r
  IN OUT UINTN *Key,\r
  OUT VOID **Section\r
  );\r
\r
EFI_STATUS\r
FvBufFindSectionByType (\r
  IN VOID *FfsFile,\r
  IN UINT8 Type,\r
  OUT VOID **Section\r
  );\r
\r
EFI_STATUS\r
FvBufGetFileRawData (\r
  IN  VOID*     FfsFile,\r
  OUT VOID**    RawData,\r
  OUT UINTN*    RawDataSize\r
  );\r
\r
EFI_STATUS\r
FvBufGetSize (\r
  IN VOID *Fv,\r
  OUT UINTN *Size\r
  );\r
\r
EFI_STATUS\r
FvBufPackageFreeformRawFile (\r
  IN EFI_GUID*  Filename,\r
  IN VOID*      RawData,\r
  IN UINTN      RawDataSize,\r
  OUT VOID**    FfsFile\r
  );\r
\r
EFI_STATUS\r
FvBufRemoveFile (\r
  IN OUT VOID *Fv,\r
  IN EFI_GUID *Name\r
  );\r
\r
EFI_STATUS\r
FvBufUnifyBlockSizes (\r
  IN OUT VOID *Fv,\r
  IN UINTN BlockSize\r
  );\r
\r
EFI_STATUS\r
FvBufShrinkWrap (\r
  IN VOID *Fv\r
  );\r
\r
#endif // #ifndef FirmwareVolumeBuffer_h_INCLUDED\r
\r