FatPkg/EnhancedFatDxe: Make the comments align with EDKIIcoding style

[mirror_edk2.git] / FatPkg / EnhancedFatDxe / Fat.h

/** @file\r
  Main header file for EFI FAT file system driver.\r
\r
Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
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 _FAT_H_\r
#define _FAT_H_\r
\r
#include <Uefi.h>\r
\r
#include <Guid/FileInfo.h>\r
#include <Guid/FileSystemInfo.h>\r
#include <Guid/FileSystemVolumeLabelInfo.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/DiskIo.h>\r
#include <Protocol/DiskIo2.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/PcdLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#include "FatFileSystem.h"\r
\r
//\r
// The FAT signature\r
//\r
#define FAT_VOLUME_SIGNATURE         SIGNATURE_32 ('f', 'a', 't', 'v')\r
#define FAT_IFILE_SIGNATURE          SIGNATURE_32 ('f', 'a', 't', 'i')\r
#define FAT_ODIR_SIGNATURE           SIGNATURE_32 ('f', 'a', 't', 'd')\r
#define FAT_DIRENT_SIGNATURE         SIGNATURE_32 ('f', 'a', 't', 'e')\r
#define FAT_OFILE_SIGNATURE          SIGNATURE_32 ('f', 'a', 't', 'o')\r
#define FAT_TASK_SIGNATURE           SIGNATURE_32 ('f', 'a', 't', 'T')\r
#define FAT_SUBTASK_SIGNATURE        SIGNATURE_32 ('f', 'a', 't', 'S')\r
\r
#define ASSERT_VOLUME_LOCKED(a)      ASSERT_LOCKED (&FatFsLock)\r
\r
#define IFILE_FROM_FHAND(a)          CR (a, FAT_IFILE, Handle, FAT_IFILE_SIGNATURE)\r
\r
#define DIRENT_FROM_LINK(a)          CR (a, FAT_DIRENT, Link, FAT_DIRENT_SIGNATURE)\r
\r
#define VOLUME_FROM_ROOT_DIRENT(a)   CR (a, FAT_VOLUME, RootDirEnt, FAT_VOLUME_SIGNATURE)\r
\r
#define VOLUME_FROM_VOL_INTERFACE(a) CR (a, FAT_VOLUME, VolumeInterface, FAT_VOLUME_SIGNATURE);\r
\r
#define ODIR_FROM_DIRCACHELINK(a)    CR (a, FAT_ODIR, DirCacheLink, FAT_ODIR_SIGNATURE)\r
\r
#define OFILE_FROM_CHECKLINK(a)      CR (a, FAT_OFILE, CheckLink, FAT_OFILE_SIGNATURE)\r
\r
#define OFILE_FROM_CHILDLINK(a)      CR (a, FAT_OFILE, ChildLink, FAT_OFILE_SIGNATURE)\r
\r
//\r
// Minimum sector size is 512B, Maximum sector size is 4096B\r
// Max sectors per cluster is 128\r
//\r
#define MAX_BLOCK_ALIGNMENT               12\r
#define MIN_BLOCK_ALIGNMENT               9\r
#define MAX_SECTORS_PER_CLUSTER_ALIGNMENT 7\r
\r
//\r
// Efi Time Definition\r
//\r
#define IS_LEAP_YEAR(a)                   (((a) % 4 == 0) && (((a) % 100 != 0) || ((a) % 400 == 0)))\r
\r
//\r
// Minimum fat page size is 8K, maximum fat page alignment is 32K\r
// Minimum data page size is 8K, maximum fat page alignment is 64K\r
//\r
#define FAT_FATCACHE_PAGE_MIN_ALIGNMENT   13\r
#define FAT_FATCACHE_PAGE_MAX_ALIGNMENT   15\r
#define FAT_DATACACHE_PAGE_MIN_ALIGNMENT  13\r
#define FAT_DATACACHE_PAGE_MAX_ALIGNMENT  16\r
#define FAT_DATACACHE_GROUP_COUNT         64\r
#define FAT_FATCACHE_GROUP_MIN_COUNT      1\r
#define FAT_FATCACHE_GROUP_MAX_COUNT      16\r
\r
//\r
// Used in 8.3 generation algorithm\r
//\r
#define MAX_SPEC_RETRY          4\r
#define SPEC_BASE_TAG_LEN       6\r
#define HASH_BASE_TAG_LEN       2\r
#define HASH_VALUE_TAG_LEN      (SPEC_BASE_TAG_LEN - HASH_BASE_TAG_LEN)\r
\r
//\r
// Path name separator is back slash\r
//\r
#define PATH_NAME_SEPARATOR     L'\\'\r
\r
\r
#define EFI_PATH_STRING_LENGTH  260\r
#define EFI_FILE_STRING_LENGTH  255\r
#define FAT_MAX_ALLOCATE_SIZE   0xA00000\r
#define LC_ISO_639_2_ENTRY_SIZE 3\r
#define MAX_LANG_CODE_SIZE      100\r
\r
#define FAT_MAX_DIR_CACHE_COUNT 8\r
#define FAT_MAX_DIRENTRY_COUNT  0xFFFF\r
typedef CHAR8                   LC_ISO_639_2;\r
\r
//\r
// The fat types we support\r
//\r
typedef enum {\r
  Fat12,\r
  Fat16,\r
  Fat32,\r
  FatUndefined\r
} FAT_VOLUME_TYPE;\r
\r
typedef enum {\r
  CacheFat,\r
  CacheData,\r
  CacheMaxType\r
} CACHE_DATA_TYPE;\r
\r
//\r
// Used in FatDiskIo\r
//\r
typedef enum {\r
  ReadDisk     = 0,  // raw disk read\r
  WriteDisk    = 1,  // raw disk write\r
  ReadFat      = 2,  // read fat cache\r
  WriteFat     = 3,  // write fat cache\r
  ReadData     = 6,  // read data cache\r
  WriteData    = 7   // write data cache\r
} IO_MODE;\r
\r
#define CACHE_ENABLED(a)  ((a) >= 2)\r
#define RAW_ACCESS(a)     ((IO_MODE)((a) & 0x1))\r
#define CACHE_TYPE(a)     ((CACHE_DATA_TYPE)((a) >> 2))\r
\r
//\r
// Disk cache tag\r
//\r
typedef struct {\r
  UINTN   PageNo;\r
  UINTN   RealSize;\r
  BOOLEAN Dirty;\r
} CACHE_TAG;\r
\r
typedef struct {\r
  UINT64    BaseAddress;\r
  UINT64    LimitAddress;\r
  UINT8     *CacheBase;\r
  BOOLEAN   Dirty;\r
  UINT8     PageAlignment;\r
  UINTN     GroupMask;\r
  CACHE_TAG CacheTag[FAT_DATACACHE_GROUP_COUNT];\r
} DISK_CACHE;\r
\r
//\r
// Hash table size\r
//\r
#define HASH_TABLE_SIZE  0x400\r
#define HASH_TABLE_MASK  (HASH_TABLE_SIZE - 1)\r
\r
//\r
// The directory entry for opened directory\r
//\r
\r
typedef struct _FAT_DIRENT FAT_DIRENT;\r
typedef struct _FAT_ODIR FAT_ODIR;\r
typedef struct _FAT_OFILE FAT_OFILE;\r
typedef struct _FAT_VOLUME FAT_VOLUME;\r
\r
struct _FAT_DIRENT {\r
  UINTN               Signature;\r
  UINT16              EntryPos;               // The position of this directory entry in the parent directory file\r
  UINT8               EntryCount;             // The count of the directory entry in the parent directory file\r
  BOOLEAN             Invalid;                // Indicate whether this directory entry is valid\r
  CHAR16              *FileString;            // The unicode long file name for this directory entry\r
  FAT_OFILE           *OFile;                 // The OFile of the corresponding directory entry\r
  FAT_DIRENT          *ShortNameForwardLink;  // Hash successor link for short filename\r
  FAT_DIRENT          *LongNameForwardLink;   // Hash successor link for long filename\r
  LIST_ENTRY          Link;                   // Connection of every directory entry\r
  FAT_DIRECTORY_ENTRY Entry;                  // The physical directory entry stored in disk\r
};\r
\r
struct _FAT_ODIR {\r
  UINTN               Signature;\r
  UINT32              CurrentEndPos;          // Current end position of the directory\r
  UINT32              CurrentPos;             // Current position of the directory\r
  LIST_ENTRY          *CurrentCursor;         // Current directory entry pointer\r
  LIST_ENTRY          ChildList;              // List of all directory entries\r
  BOOLEAN             EndOfDir;               // Indicate whether we have reached the end of the directory\r
  LIST_ENTRY          DirCacheLink;           // Linked in Volume->DirCacheList when discarded\r
  UINTN               DirCacheTag;            // The identification of the directory when in directory cache\r
  FAT_DIRENT          *LongNameHashTable[HASH_TABLE_SIZE];\r
  FAT_DIRENT          *ShortNameHashTable[HASH_TABLE_SIZE];\r
};\r
\r
typedef struct {\r
  UINTN               Signature;\r
  EFI_FILE_PROTOCOL   Handle;\r
  UINT64              Position;\r
  BOOLEAN             ReadOnly;\r
  FAT_OFILE          *OFile;\r
  LIST_ENTRY          Tasks;                  // List of all FAT_TASKs\r
  LIST_ENTRY          Link;                   // Link to other IFiles\r
} FAT_IFILE;\r
\r
typedef struct {\r
  UINTN               Signature;\r
  EFI_FILE_IO_TOKEN   *FileIoToken;\r
  FAT_IFILE           *IFile;\r
  LIST_ENTRY          Subtasks;               // List of all FAT_SUBTASKs\r
  LIST_ENTRY          Link;                   // Link to other FAT_TASKs\r
} FAT_TASK;\r
\r
typedef struct {\r
  UINTN               Signature;\r
  EFI_DISK_IO2_TOKEN  DiskIo2Token;\r
  FAT_TASK            *Task;\r
  BOOLEAN             Write;\r
  UINT64              Offset;\r
  VOID                *Buffer;\r
  UINTN               BufferSize;\r
  LIST_ENTRY          Link;\r
} FAT_SUBTASK;\r
\r
//\r
// FAT_OFILE - Each opened file\r
//\r
struct _FAT_OFILE {\r
  UINTN               Signature;\r
  FAT_VOLUME          *Volume;\r
  //\r
  // A permanant error code to return to all accesses to\r
  // this opened file\r
  //\r
  EFI_STATUS          Error;\r
  //\r
  // A list of the IFILE instances for this OFile\r
  //\r
  LIST_ENTRY          Opens;\r
\r
  //\r
  // The dynamic infomation\r
  //\r
  UINTN               FileSize;\r
  UINTN               FileCluster;\r
  UINTN               FileCurrentCluster;\r
  UINTN               FileLastCluster;\r
\r
  //\r
  // Dirty is set if there have been any updates to the\r
  // file\r
  // Archive is set if the archive attribute in the file's\r
  // directory entry needs to be set when performing flush\r
  // PreserveLastMod is set if the last modification of the\r
  // file is specified by SetInfo API\r
  //\r
  BOOLEAN             Dirty;\r
  BOOLEAN             IsFixedRootDir;\r
  BOOLEAN             PreserveLastModification;\r
  BOOLEAN             Archive;\r
  //\r
  // Set by an OFile SetPosition\r
  //\r
  UINTN               Position; // within file\r
  UINT64              PosDisk;  // on the disk\r
  UINTN               PosRem;   // remaining in this disk run\r
  //\r
  // The opened parent, full path length and currently opened child files\r
  //\r
  FAT_OFILE           *Parent;\r
  UINTN               FullPathLen;\r
  LIST_ENTRY          ChildHead;\r
  LIST_ENTRY          ChildLink;\r
\r
  //\r
  // The opened directory structure for a directory; if this\r
  // OFile represents a file, then ODir = NULL\r
  //\r
  FAT_ODIR            *ODir;\r
  //\r
  // The directory entry for the Ofile\r
  //\r
  FAT_DIRENT          *DirEnt;\r
\r
  //\r
  // Link in Volume's reference list\r
  //\r
  LIST_ENTRY          CheckLink;\r
};\r
\r
struct _FAT_VOLUME {\r
  UINTN                           Signature;\r
\r
  EFI_HANDLE                      Handle;\r
  BOOLEAN                         Valid;\r
  BOOLEAN                         DiskError;\r
\r
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL VolumeInterface;\r
\r
  //\r
  // If opened, the parent handle and BlockIo interface\r
  //\r
  EFI_BLOCK_IO_PROTOCOL           *BlockIo;\r
  EFI_DISK_IO_PROTOCOL            *DiskIo;\r
  EFI_DISK_IO2_PROTOCOL           *DiskIo2;\r
  UINT32                          MediaId;\r
  BOOLEAN                         ReadOnly;\r
\r
  //\r
  // Computed values from fat bpb info\r
  //\r
  UINT64                          VolumeSize;\r
  UINT64                          FatPos;           // Disk pos of fat tables\r
  UINT64                          RootPos;          // Disk pos of root directory\r
  UINT64                          FirstClusterPos;  // Disk pos of first cluster\r
  UINTN                           FatSize;          // Number of bytes in each fat\r
  UINTN                           MaxCluster;       // Max cluster number\r
  UINTN                           ClusterSize;      // Cluster size of fat partition\r
  UINT8                           ClusterAlignment; // Equal to log_2 (clustersize);\r
  FAT_VOLUME_TYPE                 FatType;\r
\r
  //\r
  // Current part of fat table that's present\r
  //\r
  UINT64                          FatEntryPos;    // Location of buffer\r
  UINTN                           FatEntrySize;   // Size of buffer\r
  UINT32                          FatEntryBuffer; // The buffer\r
  FAT_INFO_SECTOR                 FatInfoSector;  // Free cluster info\r
  UINTN                           FreeInfoPos;    // Pos with the free cluster info\r
  BOOLEAN                         FreeInfoValid;  // If free cluster info is valid\r
  //\r
  // Unpacked Fat BPB info\r
  //\r
  UINTN                           NumFats;\r
  UINTN                           RootEntries;    // < FAT32, root dir is fixed size\r
  UINTN                           RootCluster;    // >= FAT32, root cluster chain head\r
  //\r
  // info for marking the volume dirty or not\r
  //\r
  BOOLEAN                         FatDirty;       // If fat-entries have been updated\r
  UINT32                          DirtyValue;\r
  UINT32                          NotDirtyValue;\r
\r
  //\r
  // The root directory entry and opened root file\r
  //\r
  FAT_DIRENT                      RootDirEnt;\r
  //\r
  // File Name of root OFile, it is empty string\r
  //\r
  CHAR16                          RootFileString[1];\r
  FAT_OFILE                       *Root;\r
\r
  //\r
  // New OFiles are added to this list so they\r
  // can be cleaned up if they aren't referenced.\r
  //\r
  LIST_ENTRY                      CheckRef;\r
\r
  //\r
  // Directory cache List\r
  //\r
  LIST_ENTRY                      DirCacheList;\r
  UINTN                           DirCacheCount;\r
\r
  //\r
  // Disk Cache for this volume\r
  //\r
  VOID                            *CacheBuffer;\r
  DISK_CACHE                      DiskCache[CacheMaxType];\r
};\r
\r
//\r
// Function Prototypes\r
//\r
\r
/**\r
\r
  Implements Open() of Simple File System Protocol.\r
\r
  @param  FHand                 - File handle of the file serves as a starting reference point.\r
  @param  NewHandle             - Handle of the file that is newly opened.\r
  @param  FileName              - File name relative to FHand.\r
  @param  OpenMode              - Open mode.\r
  @param  Attributes            - Attributes to set if the file is created.\r
\r
\r
  @retval EFI_INVALID_PARAMETER - The FileName is NULL or the file string is empty.\r
                          The OpenMode is not supported.\r
                          The Attributes is not the valid attributes.\r
  @retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory for file string.\r
  @retval EFI_SUCCESS           - Open the file successfully.\r
  @return Others                - The status of open file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatOpen (\r
  IN  EFI_FILE_PROTOCOL *FHand,\r
  OUT EFI_FILE_PROTOCOL **NewHandle,\r
  IN  CHAR16            *FileName,\r
  IN  UINT64            OpenMode,\r
  IN  UINT64            Attributes\r
  )\r
;\r
\r
/**\r
\r
  Implements OpenEx() of Simple File System Protocol.\r
\r
  @param  FHand                 - File handle of the file serves as a starting reference point.\r
  @param  NewHandle             - Handle of the file that is newly opened.\r
  @param  FileName              - File name relative to FHand.\r
  @param  OpenMode              - Open mode.\r
  @param  Attributes            - Attributes to set if the file is created.\r
  @param  Token                 - A pointer to the token associated with the transaction.\r
\r
  @retval EFI_INVALID_PARAMETER - The FileName is NULL or the file string is empty.\r
                          The OpenMode is not supported.\r
                          The Attributes is not the valid attributes.\r
  @retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory for file string.\r
  @retval EFI_SUCCESS           - Open the file successfully.\r
  @return Others                - The status of open file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatOpenEx (\r
  IN  EFI_FILE_PROTOCOL       *FHand,\r
  OUT EFI_FILE_PROTOCOL       **NewHandle,\r
  IN  CHAR16                  *FileName,\r
  IN  UINT64                  OpenMode,\r
  IN  UINT64                  Attributes,\r
  IN OUT EFI_FILE_IO_TOKEN    *Token\r
  )\r
;\r
\r
/**\r
\r
  Get the file's position of the file\r
\r
  @param  FHand                 - The handle of file.\r
  @param  Position              - The file's position of the file.\r
\r
  @retval EFI_SUCCESS           - Get the info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
  @retval EFI_UNSUPPORTED       - The open file is not a file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatGetPosition (\r
  IN  EFI_FILE_PROTOCOL *FHand,\r
  OUT UINT64            *Position\r
  )\r
;\r
\r
/**\r
\r
  Get the some types info of the file into Buffer\r
\r
  @param  FHand                 - The handle of file.\r
  @param  Type                  - The type of the info.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Get the info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatGetInfo (\r
  IN     EFI_FILE_PROTOCOL      *FHand,\r
  IN     EFI_GUID               *Type,\r
  IN OUT UINTN                  *BufferSize,\r
     OUT VOID                   *Buffer\r
  )\r
;\r
\r
/**\r
\r
  Set the some types info of the file into Buffer.\r
\r
  @param  FHand                 - The handle of file.\r
  @param  Type                  - The type of the info.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Set the info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatSetInfo (\r
  IN EFI_FILE_PROTOCOL  *FHand,\r
  IN EFI_GUID           *Type,\r
  IN UINTN              BufferSize,\r
  IN VOID               *Buffer\r
  )\r
;\r
\r
/**\r
\r
  Flushes all data associated with the file handle.\r
\r
  @param  FHand                 - Handle to file to flush\r
\r
  @retval EFI_SUCCESS           - Flushed the file successfully\r
  @retval EFI_WRITE_PROTECTED   - The volume is read only\r
  @retval EFI_ACCESS_DENIED     - The volume is not read only\r
                          but the file is read only\r
  @return Others                - Flushing of the file is failed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatFlush (\r
  IN EFI_FILE_PROTOCOL  *FHand\r
  )\r
;\r
\r
/**\r
\r
  Flushes all data associated with the file handle.\r
\r
  @param  FHand                 - Handle to file to flush.\r
  @param  Token                 - A pointer to the token associated with the transaction.\r
\r
  @retval EFI_SUCCESS           - Flushed the file successfully.\r
  @retval EFI_WRITE_PROTECTED   - The volume is read only.\r
  @retval EFI_ACCESS_DENIED     - The file is read only.\r
  @return Others                - Flushing of the file failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatFlushEx (\r
  IN EFI_FILE_PROTOCOL  *FHand,\r
  IN EFI_FILE_IO_TOKEN  *Token\r
  )\r
;\r
\r
/**\r
\r
  Flushes & Closes the file handle.\r
\r
  @param  FHand                 - Handle to the file to delete.\r
\r
  @retval EFI_SUCCESS           - Closed the file successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatClose (\r
  IN EFI_FILE_PROTOCOL  *FHand\r
  )\r
;\r
\r
/**\r
\r
  Deletes the file & Closes the file handle.\r
\r
  @param  FHand                    - Handle to the file to delete.\r
\r
  @retval EFI_SUCCESS              - Delete the file successfully.\r
  @retval EFI_WARN_DELETE_FAILURE  - Fail to delete the file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatDelete (\r
  IN EFI_FILE_PROTOCOL  *FHand\r
  )\r
;\r
\r
/**\r
\r
  Set the file's position of the file.\r
\r
  @param  FHand                 - The handle of file\r
  @param  Position              - The file's position of the file\r
\r
  @retval EFI_SUCCESS           - Set the info successfully\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file\r
  @retval EFI_UNSUPPORTED       - Set a directory with a not-zero position\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatSetPosition (\r
  IN EFI_FILE_PROTOCOL  *FHand,\r
  IN UINT64             Position\r
  )\r
;\r
\r
/**\r
\r
  Get the file info.\r
\r
  @param FHand                 - The handle of the file.\r
  @param BufferSize            - Size of Buffer.\r
  @param Buffer                - Buffer containing read data.\r
\r
  @retval EFI_SUCCESS           - Get the file info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
  @retval EFI_VOLUME_CORRUPTED  - The file type of open file is error.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatRead (\r
  IN     EFI_FILE_PROTOCOL    *FHand,\r
  IN OUT UINTN                *BufferSize,\r
     OUT VOID                 *Buffer\r
  )\r
;\r
\r
/**\r
\r
  Get the file info.\r
\r
  @param FHand                 - The handle of the file.\r
  @param Token                 - A pointer to the token associated with the transaction.\r
\r
  @retval EFI_SUCCESS           - Get the file info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
  @retval EFI_VOLUME_CORRUPTED  - The file type of open file is error.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatReadEx (\r
  IN     EFI_FILE_PROTOCOL  *FHand,\r
  IN OUT EFI_FILE_IO_TOKEN  *Token\r
  )\r
;\r
\r
/**\r
\r
  Set the file info.\r
\r
  @param  FHand                 - The handle of the file.\r
  @param  BufferSize            - Size of Buffer.\r
  @param Buffer                - Buffer containing write data.\r
\r
  @retval EFI_SUCCESS           - Set the file info successfully.\r
  @retval EFI_WRITE_PROTECTED   - The disk is write protected.\r
  @retval EFI_ACCESS_DENIED     - The file is read-only.\r
  @retval EFI_DEVICE_ERROR      - The OFile is not valid.\r
  @retval EFI_UNSUPPORTED       - The open file is not a file.\r
                        - The writing file size is larger than 4GB.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatWrite (\r
  IN     EFI_FILE_PROTOCOL      *FHand,\r
  IN OUT UINTN                  *BufferSize,\r
  IN     VOID                   *Buffer\r
  )\r
;\r
\r
/**\r
\r
  Get the file info.\r
\r
  @param  FHand                 - The handle of the file.\r
  @param  Token                 - A pointer to the token associated with the transaction.\r
\r
  @retval EFI_SUCCESS           - Get the file info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
  @retval EFI_VOLUME_CORRUPTED  - The file type of open file is error.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatWriteEx (\r
  IN     EFI_FILE_PROTOCOL  *FHand,\r
  IN OUT EFI_FILE_IO_TOKEN  *Token\r
  )\r
;\r
\r
//\r
// DiskCache.c\r
//\r
EFI_STATUS\r
FatInitializeDiskCache (\r
  IN FAT_VOLUME              *Volume\r
  );\r
\r
EFI_STATUS\r
FatAccessCache (\r
  IN     FAT_VOLUME          *Volume,\r
  IN     CACHE_DATA_TYPE     CacheDataType,\r
  IN     IO_MODE             IoMode,\r
  IN     UINT64              Offset,\r
  IN     UINTN               BufferSize,\r
  IN OUT UINT8               *Buffer,\r
  IN     FAT_TASK            *Task\r
  );\r
\r
EFI_STATUS\r
FatVolumeFlushCache (\r
  IN FAT_VOLUME              *Volume,\r
  IN FAT_TASK                *Task\r
  );\r
\r
//\r
// Flush.c\r
//\r
EFI_STATUS\r
FatOFileFlush (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
BOOLEAN\r
FatCheckOFileRef (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
VOID\r
FatSetVolumeError (\r
  IN FAT_OFILE          *OFile,\r
  IN EFI_STATUS         Status\r
  );\r
\r
EFI_STATUS\r
FatIFileClose (\r
  FAT_IFILE             *IFile\r
  );\r
\r
EFI_STATUS\r
FatCleanupVolume (\r
  IN FAT_VOLUME         *Volume,\r
  IN FAT_OFILE          *OFile,\r
  IN EFI_STATUS         EfiStatus,\r
  IN FAT_TASK           *Task\r
  );\r
\r
//\r
// FileSpace.c\r
//\r
EFI_STATUS\r
FatShrinkEof (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
EFI_STATUS\r
FatGrowEof (\r
  IN FAT_OFILE          *OFile,\r
  IN UINT64             NewSizeInBytes\r
  );\r
\r
UINTN\r
FatPhysicalDirSize (\r
  IN FAT_VOLUME         *Volume,\r
  IN UINTN              Cluster\r
  );\r
\r
UINT64\r
FatPhysicalFileSize (\r
  IN FAT_VOLUME         *Volume,\r
  IN UINTN              RealSize\r
  );\r
\r
EFI_STATUS\r
FatOFilePosition (\r
  IN FAT_OFILE            *OFile,\r
  IN UINTN                Position,\r
  IN UINTN                PosLimit\r
  );\r
\r
VOID\r
FatComputeFreeInfo (\r
  IN FAT_VOLUME         *Volume\r
  );\r
\r
//\r
// Init.c\r
//\r
EFI_STATUS\r
FatAllocateVolume (\r
  IN  EFI_HANDLE                     Handle,\r
  IN  EFI_DISK_IO_PROTOCOL           *DiskIo,\r
  IN  EFI_DISK_IO2_PROTOCOL          *DiskIo2,\r
  IN  EFI_BLOCK_IO_PROTOCOL          *BlockIo\r
  );\r
\r
EFI_STATUS\r
FatOpenDevice (\r
  IN OUT FAT_VOLUME     *Volume\r
  );\r
\r
EFI_STATUS\r
FatAbandonVolume (\r
  IN FAT_VOLUME         *Volume\r
  );\r
\r
//\r
// Misc.c\r
//\r
FAT_TASK *\r
FatCreateTask (\r
  FAT_IFILE           *IFile,\r
  EFI_FILE_IO_TOKEN   *Token\r
  );\r
\r
VOID\r
FatDestroyTask (\r
  FAT_TASK            *Task\r
  );\r
\r
VOID\r
FatWaitNonblockingTask (\r
  FAT_IFILE           *IFile\r
  );\r
\r
LIST_ENTRY *\r
FatDestroySubtask (\r
  FAT_SUBTASK         *Subtask\r
  );\r
\r
EFI_STATUS\r
FatQueueTask (\r
  IN FAT_IFILE        *IFile,\r
  IN FAT_TASK         *Task\r
  );\r
\r
EFI_STATUS\r
FatAccessVolumeDirty (\r
  IN FAT_VOLUME         *Volume,\r
  IN IO_MODE            IoMode,\r
  IN VOID               *DirtyValue\r
  );\r
\r
EFI_STATUS\r
FatDiskIo (\r
  IN FAT_VOLUME         *Volume,\r
  IN IO_MODE            IoMode,\r
  IN UINT64             Offset,\r
  IN UINTN              BufferSize,\r
  IN OUT VOID           *Buffer,\r
  IN FAT_TASK           *Task\r
  );\r
\r
VOID\r
FatAcquireLock (\r
  VOID\r
  );\r
\r
VOID\r
FatReleaseLock (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
FatAcquireLockOrFail (\r
  VOID\r
  );\r
\r
VOID\r
FatFreeDirEnt (\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
VOID\r
FatFreeVolume (\r
  IN FAT_VOLUME         *Volume\r
  );\r
\r
VOID\r
FatEfiTimeToFatTime (\r
  IN EFI_TIME           *ETime,\r
  OUT FAT_DATE_TIME     *FTime\r
  );\r
\r
VOID\r
FatFatTimeToEfiTime (\r
  IN FAT_DATE_TIME      *FTime,\r
  OUT EFI_TIME          *ETime\r
  );\r
\r
VOID\r
FatGetCurrentFatTime (\r
  OUT FAT_DATE_TIME     *FatTime\r
  );\r
\r
BOOLEAN\r
FatIsValidTime (\r
  IN EFI_TIME           *Time\r
  );\r
\r
//\r
// UnicodeCollation.c\r
//\r
EFI_STATUS\r
InitializeUnicodeCollationSupport (\r
  IN EFI_HANDLE    AgentHandle\r
  );\r
\r
VOID\r
FatFatToStr (\r
  IN UINTN              FatSize,\r
  IN CHAR8              *Fat,\r
  OUT CHAR16            *String\r
  );\r
\r
BOOLEAN\r
FatStrToFat (\r
  IN  CHAR16            *String,\r
  IN  UINTN             FatSize,\r
  OUT CHAR8             *Fat\r
  );\r
\r
VOID\r
FatStrLwr (\r
  IN CHAR16             *Str\r
  );\r
\r
VOID\r
FatStrUpr (\r
  IN CHAR16             *Str\r
  );\r
\r
INTN\r
FatStriCmp (\r
  IN CHAR16             *Str1,\r
  IN CHAR16             *Str2\r
  );\r
\r
//\r
// Open.c\r
//\r
EFI_STATUS\r
FatOFileOpen (\r
  IN FAT_OFILE          *OFile,\r
  OUT FAT_IFILE         **NewIFile,\r
  IN CHAR16             *FileName,\r
  IN UINT64             OpenMode,\r
  IN UINT8              Attributes\r
  );\r
\r
EFI_STATUS\r
FatAllocateIFile (\r
  IN FAT_OFILE          *OFile,\r
  OUT FAT_IFILE         **PtrIFile\r
  );\r
\r
//\r
// OpenVolume.c\r
//\r
EFI_STATUS\r
EFIAPI\r
FatOpenVolume (\r
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
  OUT EFI_FILE_PROTOCOL               **File\r
  );\r
\r
//\r
// ReadWrite.c\r
//\r
EFI_STATUS\r
FatAccessOFile (\r
  IN FAT_OFILE          *OFile,\r
  IN IO_MODE            IoMode,\r
  IN UINTN              Position,\r
  IN UINTN              *DataBufferSize,\r
  IN UINT8              *UserBuffer,\r
  IN FAT_TASK           *Task\r
  );\r
\r
EFI_STATUS\r
FatExpandOFile (\r
  IN FAT_OFILE          *OFile,\r
  IN UINT64             ExpandedSize\r
  );\r
\r
EFI_STATUS\r
FatWriteZeroPool (\r
  IN FAT_OFILE          *OFile,\r
  IN UINTN              WritePos\r
  );\r
\r
EFI_STATUS\r
FatTruncateOFile (\r
  IN FAT_OFILE          *OFile,\r
  IN UINTN              TruncatedSize\r
  );\r
\r
//\r
// DirectoryManage.c\r
//\r
VOID\r
FatResetODirCursor (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
EFI_STATUS\r
FatGetNextDirEnt (\r
  IN  FAT_OFILE         *OFile,\r
  OUT FAT_DIRENT        **PtrDirEnt\r
  );\r
\r
EFI_STATUS\r
FatRemoveDirEnt (\r
  IN FAT_OFILE          *OFile,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
EFI_STATUS\r
FatStoreDirEnt (\r
  IN FAT_OFILE          *OFile,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
EFI_STATUS\r
FatCreateDirEnt (\r
  IN  FAT_OFILE         *OFile,\r
  IN  CHAR16            *FileName,\r
  IN  UINT8             Attributes,\r
  OUT FAT_DIRENT        **PtrDirEnt\r
  );\r
\r
BOOLEAN\r
FatIsDotDirEnt (\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
VOID\r
FatUpdateDirEntClusterSizeInfo (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
VOID\r
FatCloneDirEnt (\r
  IN  FAT_DIRENT        *DirEnt1,\r
  IN  FAT_DIRENT        *DirEnt2\r
  );\r
\r
EFI_STATUS\r
FatGetDirEntInfo (\r
  IN FAT_VOLUME         *Volume,\r
  IN FAT_DIRENT         *DirEnt,\r
  IN OUT UINTN          *BufferSize,\r
  OUT VOID              *Buffer\r
  );\r
\r
EFI_STATUS\r
FatOpenDirEnt (\r
  IN FAT_OFILE          *OFile,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
EFI_STATUS\r
FatCreateDotDirEnts (\r
  IN FAT_OFILE          *OFile\r
  );\r
\r
VOID\r
FatCloseDirEnt (\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
EFI_STATUS\r
FatLocateOFile (\r
  IN OUT FAT_OFILE      **PtrOFile,\r
  IN     CHAR16         *FileName,\r
  IN     UINT8          Attributes,\r
     OUT CHAR16         *NewFileName\r
  );\r
\r
EFI_STATUS\r
FatGetVolumeEntry (\r
  IN FAT_VOLUME         *Volume,\r
  IN CHAR16             *Name\r
  );\r
\r
EFI_STATUS\r
FatSetVolumeEntry (\r
  IN FAT_VOLUME         *Volume,\r
  IN CHAR16             *Name\r
  );\r
\r
//\r
// Hash.c\r
//\r
FAT_DIRENT **\r
FatLongNameHashSearch (\r
  IN FAT_ODIR           *ODir,\r
  IN CHAR16             *LongNameString\r
  );\r
\r
FAT_DIRENT **\r
FatShortNameHashSearch (\r
  IN FAT_ODIR           *ODir,\r
  IN CHAR8              *ShortNameString\r
  );\r
\r
VOID\r
FatInsertToHashTable (\r
  IN FAT_ODIR           *ODir,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
VOID\r
FatDeleteFromHashTable (\r
  IN FAT_ODIR           *ODir,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
//\r
// FileName.c\r
//\r
BOOLEAN\r
FatCheckIs8Dot3Name (\r
  IN CHAR16             *FileName,\r
  OUT CHAR8             *File8Dot3Name\r
  );\r
\r
VOID\r
FatCreate8Dot3Name (\r
  IN FAT_OFILE          *Parent,\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
VOID\r
FatNameToStr (\r
  IN CHAR8              *FatName,\r
  IN UINTN              Len,\r
  IN UINTN              LowerCase,\r
  IN CHAR16             *Str\r
  );\r
\r
VOID\r
FatSetCaseFlag (\r
  IN FAT_DIRENT         *DirEnt\r
  );\r
\r
VOID\r
FatGetFileNameViaCaseFlag (\r
  IN     FAT_DIRENT     *DirEnt,\r
  IN OUT CHAR16         *FileString,\r
  IN     UINTN          FileStringMax\r
  );\r
\r
UINT8\r
FatCheckSum (\r
  IN CHAR8              *ShortNameString\r
  );\r
\r
CHAR16*\r
FatGetNextNameComponent (\r
  IN  CHAR16            *Path,\r
  OUT CHAR16            *Name\r
  );\r
\r
BOOLEAN\r
FatFileNameIsValid (\r
  IN  CHAR16  *InputFileName,\r
  OUT CHAR16  *OutputFileName\r
  );\r
\r
//\r
// DirectoryCache.c\r
//\r
VOID\r
FatDiscardODir (\r
  IN FAT_OFILE    *OFile\r
  );\r
\r
VOID\r
FatRequestODir (\r
  IN FAT_OFILE    *OFile\r
  );\r
\r
VOID\r
FatCleanupODirCache (\r
  IN FAT_VOLUME   *Volume\r
  );\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL     gFatDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL     gFatComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL    gFatComponentName2;\r
extern EFI_LOCK                        FatFsLock;\r
extern EFI_LOCK                        FatTaskLock;\r
extern EFI_FILE_PROTOCOL               FatFileInterface;\r
\r
#endif\r