ArmPkg/Filesystem/SemihostFs/Arm/SemihostFs.h

   1 /** @file
   2   Support a Semi Host file system over a debuggers JTAG
   3
   4   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __SEMIHOST_FS_H__
  17 #define __SEMIHOST_FS_H__
  18
  19 EFI_STATUS
  20 VolumeOpen (
  21   IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,
  22   OUT EFI_FILE                        **Root
  23   );
  24
  25 EFI_STATUS
  26 FileOpen (
  27   IN  EFI_FILE  *File,
  28   OUT EFI_FILE  **NewHandle,
  29   IN  CHAR16    *FileName,
  30   IN  UINT64    OpenMode,
  31   IN  UINT64    Attributes
  32   );
  33
  34 EFI_STATUS
  35 FileClose (
  36   IN EFI_FILE *File
  37   );
  38
  39 EFI_STATUS
  40 FileDelete(
  41   IN EFI_FILE *File
  42   );
  43
  44 EFI_STATUS
  45 FileRead (
  46   IN     EFI_FILE *File,
  47   IN OUT UINTN    *BufferSize,
  48   OUT    VOID     *Buffer
  49   );
  50
  51 EFI_STATUS
  52 FileWrite (
  53   IN     EFI_FILE *File,
  54   IN OUT UINTN    *BufferSize,
  55   IN     VOID     *Buffer
  56   );
  57
  58 EFI_STATUS
  59 FileGetPosition (
  60   IN  EFI_FILE  *File,
  61   OUT UINT64    *Position
  62   );
  63
  64 EFI_STATUS
  65 FileSetPosition (
  66   IN EFI_FILE *File,
  67   IN UINT64   Position
  68   );
  69
  70 EFI_STATUS
  71 FileGetInfo (
  72   IN     EFI_FILE *File,
  73   IN     EFI_GUID *InformationType,
  74   IN OUT UINTN    *BufferSize,
  75   OUT    VOID     *Buffer
  76   );
  77
  78 EFI_STATUS
  79 FileSetInfo (
  80   IN EFI_FILE *File,
  81   IN EFI_GUID *InformationType,
  82   IN UINTN    BufferSize,
  83   IN VOID     *Buffer
  84   );
  85
  86 EFI_STATUS
  87 FileFlush (
  88   IN EFI_FILE *File
  89   );
  90
  91 #endif // __SEMIHOST_FS_H__
  92