BaseTools/Upt: Fix several bugs

[mirror_edk2.git] / ArmPlatformPkg / FileSystem / BootMonFs / BootMonFsApi.h

/** @file\r
*\r
*  Copyright (c) 2012-2014, ARM Limited. All rights reserved.\r
*\r
*  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
**/\r
\r
#ifndef __BOOTMON_FS_API_H\r
#define __BOOTMON_FS_API_H\r
\r
#include <Protocol/SimpleFileSystem.h>\r
\r
EFI_STATUS\r
BootMonFsInitialize (\r
  IN BOOTMON_FS_INSTANCE *Instance\r
  );\r
\r
UINT32\r
BootMonFsChecksum (\r
  IN VOID   *Data,\r
  IN UINT32 Size\r
  );\r
\r
EFI_STATUS\r
BootMonFsComputeFooterChecksum (\r
  IN OUT HW_IMAGE_DESCRIPTION *Footer\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
OpenBootMonFsOpenVolume (\r
  IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
  OUT EFI_FILE_PROTOCOL              **Root\r
  );\r
\r
UINT32\r
BootMonFsGetImageLength (\r
  IN BOOTMON_FS_FILE      *File\r
  );\r
\r
UINTN\r
BootMonFsGetPhysicalSize (\r
  IN BOOTMON_FS_FILE* File\r
  );\r
\r
EFI_STATUS\r
BootMonFsCreateFile (\r
  IN  BOOTMON_FS_INSTANCE *Instance,\r
  OUT BOOTMON_FS_FILE     **File\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsGetInfo (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN EFI_GUID           *InformationType,\r
  IN OUT UINTN          *BufferSize,\r
  OUT VOID              *Buffer\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsReadDirectory (\r
  IN EFI_FILE_PROTOCOL    *This,\r
  IN OUT UINTN            *BufferSize,\r
  OUT VOID                *Buffer\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsFlushDirectory (\r
  IN EFI_FILE_PROTOCOL  *This\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsFlushFile (\r
  IN EFI_FILE_PROTOCOL  *This\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsCloseFile (\r
  IN EFI_FILE_PROTOCOL  *This\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsOpenFile (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  OUT EFI_FILE_PROTOCOL **NewHandle,\r
  IN CHAR16             *FileName,\r
  IN UINT64             OpenMode,\r
  IN UINT64             Attributes\r
  );\r
\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsReadFile (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN OUT UINTN          *BufferSize,\r
  OUT VOID              *Buffer\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsSetDirPosition (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN UINT64             Position\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsGetPosition (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  OUT UINT64            *Position\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsWriteFile (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN OUT UINTN          *BufferSize,\r
  IN VOID               *Buffer\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsDeleteFail (\r
  IN EFI_FILE_PROTOCOL *This\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsDelete (\r
  IN EFI_FILE_PROTOCOL *This\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsSetPosition (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN UINT64             Position\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsGetPosition(\r
  IN EFI_FILE_PROTOCOL  *This,\r
  OUT UINT64            *Position\r
  );\r
\r
//\r
// UNSUPPORTED OPERATIONS\r
//\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsGetPositionUnsupported (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  OUT UINT64            *Position\r
  );\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsSetInfo (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN EFI_GUID           *InformationType,\r
  IN UINTN              BufferSize,\r
  IN VOID               *Buffer\r
  );\r
\r
//\r
// Directory API\r
//\r
\r
EFI_STATUS\r
BootMonFsOpenDirectory (\r
  OUT EFI_FILE_PROTOCOL **NewHandle,\r
  IN CHAR16             *FileName,\r
  IN BOOTMON_FS_INSTANCE *Volume\r
  );\r
\r
//\r
// Internal API\r
//\r
EFI_STATUS\r
BootMonGetFileFromAsciiFileName (\r
  IN  BOOTMON_FS_INSTANCE   *Instance,\r
  IN  CHAR8*                AsciiFileName,\r
  OUT BOOTMON_FS_FILE       **File\r
  );\r
\r
EFI_STATUS\r
BootMonGetFileFromPosition (\r
  IN  BOOTMON_FS_INSTANCE   *Instance,\r
  IN  UINTN                 Position,\r
  OUT BOOTMON_FS_FILE       **File\r
  );\r
\r
#endif\r