[mirror_edk2.git] / MdeModulePkg / Universal / FvSimpleFileSystemDxe / FvSimpleFileSystem.c

/** @file\r
  This driver uses the EFI_FIRMWARE_VOLUME2_PROTOCOL to expose files in firmware\r
  volumes via the the EFI_SIMPLE_FILESYSTEM_PROTOCOL and EFI_FILE_PROTOCOL.\r
\r
  It will expose a single directory, containing one file for each file in the firmware\r
  volume. If a file has a UI section, its contents will be used as a filename.\r
  Otherwise, a string representation of the GUID will be used.\r
  Files of an executable type (That is PEIM, DRIVER, COMBINED_PEIM_DRIVER and APPLICATION)\r
  will have ".efi" added to their filename.\r
\r
  Its primary intended use is to be able to start EFI applications embedded in FVs\r
  from the UEFI shell. It is entirely read-only.\r
\r
Copyright (c) 2014, ARM Limited. All rights reserved.\r
Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "FvSimpleFileSystemInternal.h"\r
\r
//\r
// Template for EFI_FILE_SYSTEM_INFO data structure.\r
//\r
EFI_FILE_SYSTEM_INFO mFsInfoTemplate = {\r
  0,    // Populate at runtime\r
  TRUE, // Read-only\r
  0,    // Don't know volume size\r
  0,    // No free space\r
  0,    // Don't know block size\r
  L""   // Populate at runtime\r
};\r
\r
//\r
// Template for EFI_FILE_PROTOCOL data structure.\r
//\r
EFI_FILE_PROTOCOL mFileSystemTemplate = {\r
  EFI_FILE_PROTOCOL_REVISION,\r
  FvSimpleFileSystemOpen,\r
  FvSimpleFileSystemClose,\r
  FvSimpleFileSystemDelete,\r
  FvSimpleFileSystemRead,\r
  FvSimpleFileSystemWrite,\r
  FvSimpleFileSystemGetPosition,\r
  FvSimpleFileSystemSetPosition,\r
  FvSimpleFileSystemGetInfo,\r
  FvSimpleFileSystemSetInfo,\r
  FvSimpleFileSystemFlush\r
};\r
\r
/**\r
  Find and call ReadSection on the first section found of an executable type.\r
\r
  @param  FvProtocol                  A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  @param  FvFileInfo                  A pointer to the FV_FILESYSTEM_FILE_INFO instance that is a struct\r
                                      representing a file's info.\r
  @param  BufferSize                  Pointer to a caller-allocated UINTN. It indicates the size of\r
                                      the memory represented by *Buffer.\r
  @param  Buffer                      Pointer to a pointer to a data buffer to contain file content.\r
\r
  @retval EFI_SUCCESS                 The call completed successfully.\r
  @retval EFI_WARN_BUFFER_TOO_SMALL   The buffer is too small to contain the requested output.\r
  @retval EFI_ACCESS_DENIED           The firmware volume is configured to disallow reads.\r
  @retval EFI_NOT_FOUND               The requested file was not found in the firmware volume.\r
  @retval EFI_DEVICE_ERROR            A hardware error occurred when attempting toaccess the firmware volume.\r
\r
**/\r
EFI_STATUS\r
FvFsFindExecutableSection (\r
  IN     EFI_FIRMWARE_VOLUME2_PROTOCOL     *FvProtocol,\r
  IN     FV_FILESYSTEM_FILE_INFO           *FvFileInfo,\r
  IN OUT UINTN                             *BufferSize,\r
  IN OUT VOID                              **Buffer\r
  )\r
{\r
  EFI_SECTION_TYPE                    SectionType;\r
  UINT32                              AuthenticationStatus;\r
  EFI_STATUS                          Status;\r
\r
  for (SectionType = EFI_SECTION_PE32; SectionType <= EFI_SECTION_TE; SectionType++) {\r
    Status = FvProtocol->ReadSection (\r
                           FvProtocol,\r
                           &FvFileInfo->NameGuid,\r
                           SectionType,\r
                           0,\r
                           Buffer,\r
                           BufferSize,\r
                           &AuthenticationStatus\r
                           );\r
    if (Status != EFI_NOT_FOUND) {\r
      return Status;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Get the size of the buffer that will be returned by FvFsReadFile.\r
\r
  @param  FvProtocol                  A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  @param  FvFileInfo                  A pointer to the FV_FILESYSTEM_FILE_INFO instance that is a struct\r
                                      representing a file's info.\r
\r
  @retval EFI_SUCCESS                 The file size was gotten correctly.\r
  @retval Others                      The file size wasn't gotten correctly.\r
\r
**/\r
EFI_STATUS\r
FvFsGetFileSize (\r
  IN     EFI_FIRMWARE_VOLUME2_PROTOCOL     *FvProtocol,\r
  IN OUT FV_FILESYSTEM_FILE_INFO           *FvFileInfo\r
  )\r
{\r
  UINT32                         AuthenticationStatus;\r
  EFI_FV_FILETYPE                FoundType;\r
  EFI_FV_FILE_ATTRIBUTES         Attributes;\r
  EFI_STATUS                     Status;\r
  UINT8                          IgnoredByte;\r
  VOID                           *IgnoredPtr;\r
\r
  //\r
  // To get the size of a section, we pass 0 for BufferSize. But we can't pass\r
  // NULL for Buffer, as that will cause a return of INVALID_PARAMETER, and we\r
  // can't pass NULL for *Buffer, as that will cause the callee to allocate\r
  // a buffer of the sections size.\r
  //\r
  IgnoredPtr = &IgnoredByte;\r
  FvFileInfo->FileInfo.FileSize = 0;\r
\r
  if (FV_FILETYPE_IS_EXECUTABLE (FvFileInfo->Type)) {\r
    //\r
    // Get the size of the first executable section out of the file.\r
    //\r
    Status = FvFsFindExecutableSection (FvProtocol, FvFileInfo, (UINTN*)&FvFileInfo->FileInfo.FileSize, &IgnoredPtr);\r
    if (Status == EFI_WARN_BUFFER_TOO_SMALL) {\r
      return EFI_SUCCESS;\r
    }\r
  } else if (FvFileInfo->Type == EFI_FV_FILETYPE_FREEFORM) {\r
    //\r
    // Try to get the size of a raw section out of the file\r
    //\r
    Status = FvProtocol->ReadSection (\r
                           FvProtocol,\r
                           &FvFileInfo->NameGuid,\r
                           EFI_SECTION_RAW,\r
                           0,\r
                           &IgnoredPtr,\r
                           (UINTN*)&FvFileInfo->FileInfo.FileSize,\r
                           &AuthenticationStatus\r
                           );\r
    if (Status == EFI_WARN_BUFFER_TOO_SMALL) {\r
      return EFI_SUCCESS;\r
    }\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Didn't find a raw section, just return the whole file's size.\r
      //\r
      return FvProtocol->ReadFile (\r
                           FvProtocol,\r
                           &FvFileInfo->NameGuid,\r
                           NULL,\r
                           (UINTN*)&FvFileInfo->FileInfo.FileSize,\r
                           &FoundType,\r
                           &Attributes,\r
                           &AuthenticationStatus\r
                           );\r
    }\r
  } else {\r
    //\r
    // Get the size of the entire file\r
    //\r
    return FvProtocol->ReadFile (\r
                         FvProtocol,\r
                         &FvFileInfo->NameGuid,\r
                         NULL,\r
                         (UINTN*)&FvFileInfo->FileInfo.FileSize,\r
                         &FoundType,\r
                         &Attributes,\r
                         &AuthenticationStatus\r
                         );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Helper function to read a file.\r
\r
  The data returned depends on the type of the underlying FV file:\r
  - For executable types, the first section found that contains executable code is returned.\r
  - For files of type FREEFORM, the driver attempts to return the first section of type RAW.\r
    If none is found, the entire contents of the FV file are returned.\r
  - On all other files the entire contents of the FV file is returned, as by\r
    EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadFile.\r
\r
  @param  FvProtocol                  A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  @param  FvFileInfo                  A pointer to the FV_FILESYSTEM_FILE_INFO instance that is a struct\r
                                      representing a file's info.\r
  @param  BufferSize                  Pointer to a caller-allocated UINTN. It indicates the size of\r
                                      the memory represented by *Buffer.\r
  @param  Buffer                      Pointer to a pointer to a data buffer to contain file content.\r
\r
  @retval EFI_SUCCESS                 The call completed successfully.\r
  @retval EFI_WARN_BUFFER_TOO_SMALL   The buffer is too small to contain the requested output.\r
  @retval EFI_ACCESS_DENIED           The firmware volume is configured to disallow reads.\r
  @retval EFI_NOT_FOUND               The requested file was not found in the firmware volume.\r
  @retval EFI_DEVICE_ERROR            A hardware error occurred when attempting toaccess the firmware volume.\r
\r
**/\r
EFI_STATUS\r
FvFsReadFile (\r
  IN     EFI_FIRMWARE_VOLUME2_PROTOCOL     *FvProtocol,\r
  IN     FV_FILESYSTEM_FILE_INFO           *FvFileInfo,\r
  IN OUT UINTN                             *BufferSize,\r
  IN OUT VOID                              **Buffer\r
  )\r
{\r
  UINT32                         AuthenticationStatus;\r
  EFI_FV_FILETYPE                FoundType;\r
  EFI_FV_FILE_ATTRIBUTES         Attributes;\r
  EFI_STATUS                     Status;\r
\r
  if (FV_FILETYPE_IS_EXECUTABLE (FvFileInfo->Type)) {\r
    //\r
    // Read the first executable section out of the file.\r
    //\r
    Status = FvFsFindExecutableSection (FvProtocol, FvFileInfo, BufferSize, Buffer);\r
  } else if (FvFileInfo->Type == EFI_FV_FILETYPE_FREEFORM) {\r
    //\r
    // Try to read a raw section out of the file\r
    //\r
    Status = FvProtocol->ReadSection (\r
                           FvProtocol,\r
                           &FvFileInfo->NameGuid,\r
                           EFI_SECTION_RAW,\r
                           0,\r
                           Buffer,\r
                           BufferSize,\r
                           &AuthenticationStatus\r
                           );\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Didn't find a raw section, just return the whole file.\r
      //\r
      Status = FvProtocol->ReadFile (\r
                             FvProtocol,\r
                             &FvFileInfo->NameGuid,\r
                             Buffer,\r
                             BufferSize,\r
                             &FoundType,\r
                             &Attributes,\r
                             &AuthenticationStatus\r
                             );\r
    }\r
  } else {\r
    //\r
    // Read the entire file\r
    //\r
    Status = FvProtocol->ReadFile (\r
                           FvProtocol,\r
                           &FvFileInfo->NameGuid,\r
                           Buffer,\r
                           BufferSize,\r
                           &FoundType,\r
                           &Attributes,\r
                           &AuthenticationStatus\r
                           );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Helper function for populating an EFI_FILE_INFO for a file.\r
\r
  Note the CreateTime, LastAccessTime and ModificationTime fields in EFI_FILE_INFO\r
  are full zero as FV2 protocol has no corresponding info to fill.\r
\r
  @param  FvFileInfo                  A pointer to the FV_FILESYSTEM_FILE_INFO instance that is a struct\r
                                      representing a file's info.\r
  @param  BufferSize                  Pointer to a caller-allocated UINTN. It indicates the size of\r
                                      the memory represented by FileInfo.\r
  @param  FileInfo                    A pointer to EFI_FILE_INFO to contain the returned file info.\r
\r
  @retval EFI_SUCCESS                 The call completed successfully.\r
  @retval EFI_BUFFER_TOO_SMALL        The buffer is too small to contain the requested output.\r
\r
**/\r
EFI_STATUS\r
FvFsGetFileInfo (\r
  IN     FV_FILESYSTEM_FILE_INFO           *FvFileInfo,\r
  IN OUT UINTN                             *BufferSize,\r
     OUT EFI_FILE_INFO                     *FileInfo\r
  )\r
{\r
  UINTN                      InfoSize;\r
\r
  InfoSize = (UINTN)FvFileInfo->FileInfo.Size;\r
  if (*BufferSize < InfoSize) {\r
    *BufferSize = InfoSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  //\r
  // Initialize FileInfo\r
  //\r
  CopyMem (FileInfo, &FvFileInfo->FileInfo, InfoSize);\r
\r
  *BufferSize = InfoSize;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Removes the last directory or file entry in a path by changing the last\r
  L'\' to a CHAR_NULL.\r
\r
  @param  Path      The pointer to the path to modify.\r
\r
  @retval FALSE     Nothing was found to remove.\r
  @retval TRUE      A directory or file was removed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
RemoveLastItemFromPath (\r
  IN OUT CHAR16 *Path\r
  )\r
{\r
  CHAR16        *Walker;\r
  CHAR16        *LastSlash;\r
  //\r
  // get directory name from path... ('chop' off extra)\r
  //\r
  for ( Walker = Path, LastSlash = NULL\r
      ; Walker != NULL && *Walker != CHAR_NULL\r
      ; Walker++\r
     ){\r
    if (*Walker == L'\\' && *(Walker + 1) != CHAR_NULL) {\r
      LastSlash = Walker + 1;\r
    }\r
  }\r
\r
  if (LastSlash != NULL) {\r
    *LastSlash = CHAR_NULL;\r
    return (TRUE);\r
  }\r
\r
  return (FALSE);\r
}\r
\r
/**\r
  Function to clean up paths.\r
\r
  - Single periods in the path are removed.\r
  - Double periods in the path are removed along with a single parent directory.\r
  - Forward slashes L'/' are converted to backward slashes L'\'.\r
\r
  This will be done inline and the existing buffer may be larger than required\r
  upon completion.\r
\r
  @param  Path          The pointer to the string containing the path.\r
\r
  @retval NULL          An error occured.\r
  @return Path in all other instances.\r
\r
**/\r
CHAR16*\r
EFIAPI\r
TrimFilePathToAbsolutePath (\r
  IN CHAR16 *Path\r
  )\r
{\r
  CHAR16  *TempString;\r
  UINTN   TempSize;\r
\r
  if (Path == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Fix up the '/' vs '\'\r
  //\r
  for (TempString = Path ; (TempString != NULL) && (*TempString != CHAR_NULL); TempString++) {\r
    if (*TempString == L'/') {\r
      *TempString = L'\\';\r
    }\r
  }\r
\r
  //\r
  // Fix up the ..\r
  //\r
  while ((TempString = StrStr (Path, L"\\..\\")) != NULL) {\r
    *TempString  = CHAR_NULL;\r
    TempString  += 4;\r
    RemoveLastItemFromPath (Path);\r
    TempSize     = StrSize (TempString);\r
    CopyMem (Path + StrLen (Path), TempString, TempSize);\r
  }\r
\r
  if (((TempString = StrStr (Path, L"\\..")) != NULL) && (*(TempString + 3) == CHAR_NULL)) {\r
    *TempString  = CHAR_NULL;\r
    RemoveLastItemFromPath (Path);\r
  }\r
\r
  //\r
  // Fix up the .\r
  //\r
  while ((TempString = StrStr (Path, L"\\.\\")) != NULL) {\r
    *TempString  = CHAR_NULL;\r
    TempString  += 2;\r
    TempSize     = StrSize (TempString);\r
    CopyMem(Path + StrLen (Path), TempString, TempSize);\r
  }\r
\r
  if (((TempString = StrStr (Path, L"\\.")) != NULL) && (*(TempString + 2) == CHAR_NULL)) {\r
    *(TempString + 1) = CHAR_NULL;\r
  }\r
\r
  while ((TempString = StrStr (Path, L"\\\\")) != NULL) {\r
    *TempString  = CHAR_NULL;\r
    TempString  += 1;\r
    TempSize     = StrSize(TempString);\r
    CopyMem(Path + StrLen(Path), TempString, TempSize);\r
  }\r
\r
  if (((TempString = StrStr(Path, L"\\\\")) != NULL) && (*(TempString + 1) == CHAR_NULL)) {\r
    *(TempString) = CHAR_NULL;\r
  }\r
\r
  return Path;\r
}\r
\r
/**\r
  Opens a new file relative to the source file's location.\r
\r
  @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                     handle to the source location. This would typically be an open\r
                     handle to a directory.\r
  @param  NewHandle  A pointer to the location to return the opened handle for the new\r
                     file.\r
  @param  FileName   The Null-terminated string of the name of the file to be opened.\r
                     The file name may contain the following path modifiers: "\", ".",\r
                     and "..".\r
  @param  OpenMode   The mode to open the file. The only valid combinations that the\r
                     file may be opened with are: Read, Read/Write, or Create/Read/Write.\r
  @param  Attributes Only valid for EFI_FILE_MODE_CREATE, in which case these are the\r
                     attribute bits for the newly created file.\r
\r
  @retval EFI_SUCCESS          The file was opened.\r
  @retval EFI_NOT_FOUND        The specified file could not be found on the device.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_MEDIA_CHANGED    The device has a different medium in it or the medium is no\r
                               longer supported.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  An attempt was made to create a file, or open a file for write\r
                               when the media is write-protected.\r
  @retval EFI_ACCESS_DENIED    The service denied access to the file.\r
  @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemOpen (\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
  FV_FILESYSTEM_INSTANCE      *Instance;\r
  FV_FILESYSTEM_FILE          *File;\r
  FV_FILESYSTEM_FILE          *NewFile;\r
  FV_FILESYSTEM_FILE_INFO     *FvFileInfo;\r
  LIST_ENTRY                  *FvFileInfoLink;\r
  EFI_STATUS                  Status;\r
  UINTN                       FileNameLength;\r
  UINTN                       NewFileNameLength;\r
  CHAR16                      *FileNameWithExtension;\r
\r
  //\r
  // Check for a valid mode\r
  //\r
  switch (OpenMode) {\r
  case EFI_FILE_MODE_READ:\r
    break;\r
\r
  default:\r
    return EFI_WRITE_PROTECTED;\r
  }\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  FileName = TrimFilePathToAbsolutePath (FileName);\r
  if (FileName == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (FileName[0] == L'\\') {\r
    FileName++;\r
  }\r
\r
  //\r
  // Check for opening root\r
  //\r
  if (StrCmp (FileName, L".") == 0 || StrCmp (FileName, L"") == 0) {\r
    NewFile = AllocateZeroPool (sizeof (FV_FILESYSTEM_FILE));\r
    if (NewFile == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    NewFile->Signature = FVFS_FILE_SIGNATURE;\r
    NewFile->Instance  = Instance;\r
    NewFile->FvFileInfo = File->FvFileInfo;\r
    CopyMem (&NewFile->FileProtocol, &mFileSystemTemplate, sizeof (mFileSystemTemplate));\r
    InitializeListHead (&NewFile->Link);\r
    InsertHeadList (&Instance->FileHead, &NewFile->Link);\r
\r
    NewFile->DirReadNext = NULL;\r
    if (!IsListEmpty (&Instance->FileInfoHead)) {\r
      NewFile->DirReadNext = FVFS_GET_FIRST_FILE_INFO (Instance);\r
    }\r
\r
    *NewHandle = &NewFile->FileProtocol;\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Do a linear search for a file in the FV with a matching filename\r
  //\r
  Status     = EFI_NOT_FOUND;\r
  FvFileInfo = NULL;\r
  for (FvFileInfoLink = GetFirstNode (&Instance->FileInfoHead);\r
      !IsNull (&Instance->FileInfoHead, FvFileInfoLink);\r
       FvFileInfoLink = GetNextNode (&Instance->FileInfoHead, FvFileInfoLink)) {\r
    FvFileInfo = FVFS_FILE_INFO_FROM_LINK (FvFileInfoLink);\r
    if (mUnicodeCollation->StriColl (mUnicodeCollation, &FvFileInfo->FileInfo.FileName[0], FileName) == 0) {\r
      Status = EFI_SUCCESS;\r
      break;\r
    }\r
  }\r
\r
  // If the file has not been found check if the filename exists with an extension\r
  // in case there was no extension present.\r
  // FvFileSystem adds a 'virtual' extension '.EFI' to EFI applications and drivers\r
  // present in the Firmware Volume\r
  if (Status == EFI_NOT_FOUND) {\r
    FileNameLength = StrLen (FileName);\r
\r
    // Does the filename already contain the '.EFI' extension?\r
    if (mUnicodeCollation->StriColl (mUnicodeCollation, FileName + FileNameLength - 4, L".efi") != 0) {\r
      // No, there was no extension. So add one and search again for the file\r
      // NewFileNameLength = FileNameLength + 1 + 4 = (Number of non-null character) + (file extension) + (a null character)\r
      NewFileNameLength = FileNameLength + 1 + 4;\r
      FileNameWithExtension = AllocatePool (NewFileNameLength * 2);\r
      StrCpyS (FileNameWithExtension, NewFileNameLength, FileName);\r
      StrCatS (FileNameWithExtension, NewFileNameLength, L".EFI");\r
\r
      for (FvFileInfoLink = GetFirstNode (&Instance->FileInfoHead);\r
          !IsNull (&Instance->FileInfoHead, FvFileInfoLink);\r
           FvFileInfoLink = GetNextNode (&Instance->FileInfoHead, FvFileInfoLink)) {\r
        FvFileInfo = FVFS_FILE_INFO_FROM_LINK (FvFileInfoLink);\r
        if (mUnicodeCollation->StriColl (mUnicodeCollation, &FvFileInfo->FileInfo.FileName[0], FileNameWithExtension) == 0) {\r
          Status = EFI_SUCCESS;\r
          break;\r
        }\r
      }\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    NewFile = AllocateZeroPool (sizeof (FV_FILESYSTEM_FILE));\r
    if (NewFile == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    NewFile->Signature = FVFS_FILE_SIGNATURE;\r
    NewFile->Instance  = Instance;\r
    NewFile->FvFileInfo = FvFileInfo;\r
    CopyMem (&NewFile->FileProtocol, &mFileSystemTemplate, sizeof (mFileSystemTemplate));\r
    InitializeListHead (&NewFile->Link);\r
    InsertHeadList (&Instance->FileHead, &NewFile->Link);\r
\r
    *NewHandle = &NewFile->FileProtocol;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Closes a specified file handle.\r
\r
  @param  This          A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                        handle to close.\r
\r
  @retval EFI_SUCCESS   The file was closed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemClose (\r
  IN EFI_FILE_PROTOCOL  *This\r
  )\r
{\r
  FV_FILESYSTEM_INSTANCE      *Instance;\r
  FV_FILESYSTEM_FILE          *File;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  if (File != Instance->Root) {\r
    RemoveEntryList (&File->Link);\r
    FreePool (File);\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads data from a file.\r
\r
  @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                     handle to read data from.\r
  @param  BufferSize On input, the size of the Buffer. On output, the amount of data\r
                     returned in Buffer. In both cases, the size is measured in bytes.\r
  @param  Buffer     The buffer into which the data is read.\r
\r
  @retval EFI_SUCCESS          Data was read.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_DEVICE_ERROR     An attempt was made to read from a deleted file.\r
  @retval EFI_DEVICE_ERROR     On entry, the current file position is beyond the end of the file.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory\r
                               entry. BufferSize has been updated with the size\r
                               needed to complete the request.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemRead (\r
  IN     EFI_FILE_PROTOCOL      *This,\r
  IN OUT UINTN                  *BufferSize,\r
     OUT VOID                   *Buffer\r
  )\r
{\r
  FV_FILESYSTEM_INSTANCE        *Instance;\r
  FV_FILESYSTEM_FILE            *File;\r
  EFI_STATUS                    Status;\r
  LIST_ENTRY                    *FvFileInfoLink;\r
  VOID                          *FileBuffer;\r
  UINTN                         FileSize;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  if (File->FvFileInfo == Instance->Root->FvFileInfo) {\r
    if (File->DirReadNext) {\r
      //\r
      // Directory read: populate Buffer with an EFI_FILE_INFO\r
      //\r
      Status = FvFsGetFileInfo (File->DirReadNext, BufferSize, Buffer);\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Successfully read a directory entry, now update the pointer to the\r
        // next file, which will be read on the next call to this function\r
        //\r
        FvFileInfoLink = GetNextNode (&Instance->FileInfoHead, &File->DirReadNext->Link);\r
        if (IsNull (&Instance->FileInfoHead, FvFileInfoLink)) {\r
          //\r
          // No more files left\r
          //\r
          File->DirReadNext = NULL;\r
        } else {\r
          File->DirReadNext = FVFS_FILE_INFO_FROM_LINK (FvFileInfoLink);\r
        }\r
      }\r
      return Status;\r
    } else {\r
      //\r
      // Directory read. All entries have been read, so return a zero-size\r
      // buffer.\r
      //\r
      *BufferSize = 0;\r
      return EFI_SUCCESS;\r
    }\r
  } else {\r
    FileSize = (UINTN)File->FvFileInfo->FileInfo.FileSize;\r
\r
    FileBuffer = AllocateZeroPool (FileSize);\r
    if (FileBuffer == NULL) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    Status = FvFsReadFile (File->Instance->FvProtocol, File->FvFileInfo, &FileSize, &FileBuffer);\r
    if (EFI_ERROR (Status)) {\r
      FreePool (FileBuffer);\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    if (*BufferSize + File->Position > FileSize) {\r
      *BufferSize = (UINTN)(FileSize - File->Position);\r
    }\r
\r
    CopyMem (Buffer, (UINT8*)FileBuffer + File->Position, *BufferSize);\r
    File->Position += *BufferSize;\r
\r
    FreePool (FileBuffer);\r
\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
  Writes data to a file.\r
\r
  @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                     handle to write data to.\r
  @param  BufferSize On input, the size of the Buffer. On output, the amount of data\r
                     actually written. In both cases, the size is measured in bytes.\r
  @param  Buffer     The buffer of data to write.\r
\r
  @retval EFI_SUCCESS          Data was written.\r
  @retval EFI_UNSUPPORTED      Writes to open directory files are not supported.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.\r
  @retval EFI_ACCESS_DENIED    The file was opened read only.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemWrite (\r
  IN     EFI_FILE_PROTOCOL    *This,\r
  IN OUT UINTN                *BufferSize,\r
  IN     VOID                 *Buffer\r
  )\r
{\r
  FV_FILESYSTEM_INSTANCE        *Instance;\r
  FV_FILESYSTEM_FILE            *File;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  if (File->FvFileInfo == Instance->Root->FvFileInfo) {\r
    return EFI_UNSUPPORTED;\r
  } else {\r
    return EFI_WRITE_PROTECTED;\r
  }\r
}\r
\r
/**\r
  Returns a file's current position.\r
\r
  @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                          handle to get the current position on.\r
  @param  Position        The address to return the file's current position value.\r
\r
  @retval EFI_SUCCESS      The position was returned.\r
  @retval EFI_UNSUPPORTED  The request is not valid on open directories.\r
  @retval EFI_DEVICE_ERROR An attempt was made to get the position from a deleted file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemGetPosition (\r
  IN     EFI_FILE_PROTOCOL    *This,\r
     OUT UINT64               *Position\r
  )\r
{\r
  FV_FILESYSTEM_INSTANCE        *Instance;\r
  FV_FILESYSTEM_FILE            *File;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  if (File->FvFileInfo == Instance->Root->FvFileInfo) {\r
    return EFI_UNSUPPORTED;\r
  } else {\r
    *Position = File->Position;\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
  Sets a file's current position.\r
\r
  @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the\r
                          file handle to set the requested position on.\r
  @param  Position        The byte position from the start of the file to set.\r
\r
  @retval EFI_SUCCESS      The position was set.\r
  @retval EFI_UNSUPPORTED  The seek request for nonzero is not valid on open\r
                           directories.\r
  @retval EFI_DEVICE_ERROR An attempt was made to set the position of a deleted file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemSetPosition (\r
  IN EFI_FILE_PROTOCOL        *This,\r
  IN UINT64                   Position\r
  )\r
{\r
  FV_FILESYSTEM_INSTANCE      *Instance;\r
  FV_FILESYSTEM_FILE          *File;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
  Instance = File->Instance;\r
\r
  if (File->FvFileInfo == Instance->Root->FvFileInfo) {\r
    if (Position != 0) {\r
      return EFI_UNSUPPORTED;\r
    }\r
    //\r
    // Reset directory position to first entry\r
    //\r
    if (File->DirReadNext) {\r
      File->DirReadNext = FVFS_GET_FIRST_FILE_INFO (Instance);\r
    }\r
  } else if (Position == 0xFFFFFFFFFFFFFFFFull) {\r
    File->Position = File->FvFileInfo->FileInfo.FileSize;\r
  } else {\r
    File->Position = Position;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Flushes all modified data associated with a file to a device.\r
\r
  @param  This A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
               handle to flush.\r
\r
  @retval EFI_SUCCESS          The data was flushed.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.\r
  @retval EFI_ACCESS_DENIED    The file was opened read-only.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemFlush (\r
  IN EFI_FILE_PROTOCOL  *This\r
  )\r
{\r
  return EFI_WRITE_PROTECTED;\r
}\r
\r
/**\r
  Close and delete the file handle.\r
\r
  @param  This                     A pointer to the EFI_FILE_PROTOCOL instance that is the\r
                                   handle to the file to delete.\r
\r
  @retval EFI_SUCCESS              The file was closed and deleted, and the handle was closed.\r
  @retval EFI_WARN_DELETE_FAILURE  The handle was closed, but the file was not deleted.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemDelete (\r
  IN EFI_FILE_PROTOCOL *This\r
  )\r
{\r
  EFI_STATUS       Status;\r
\r
  Status = FvSimpleFileSystemClose (This);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_WARN_DELETE_FAILURE;\r
}\r
\r
/**\r
  Returns information about a file.\r
\r
  @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                          handle the requested information is for.\r
  @param  InformationType The type identifier for the information being requested.\r
  @param  BufferSize      On input, the size of Buffer. On output, the amount of data\r
                          returned in Buffer. In both cases, the size is measured in bytes.\r
  @param  Buffer          A pointer to the data buffer to return. The buffer's type is\r
                          indicated by InformationType.\r
\r
  @retval EFI_SUCCESS          The information was returned.\r
  @retval EFI_UNSUPPORTED      The InformationType is not known.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory entry.\r
                               BufferSize has been updated with the size needed to complete\r
                               the request.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemGetInfo (\r
  IN     EFI_FILE_PROTOCOL    *This,\r
  IN     EFI_GUID             *InformationType,\r
  IN OUT UINTN                *BufferSize,\r
     OUT VOID                 *Buffer\r
  )\r
{\r
  FV_FILESYSTEM_FILE           *File;\r
  EFI_FILE_SYSTEM_INFO         *FsInfoOut;\r
  EFI_FILE_SYSTEM_VOLUME_LABEL *FsVolumeLabel;\r
  FV_FILESYSTEM_INSTANCE       *Instance;\r
  UINTN                        Size;\r
  EFI_STATUS                   Status;\r
\r
  File = FVFS_FILE_FROM_FILE_THIS (This);\r
\r
  if (CompareGuid (InformationType, &gEfiFileSystemInfoGuid)) {\r
    //\r
    // Return filesystem info\r
    //\r
    Instance = File->Instance;\r
\r
    Size = sizeof (EFI_FILE_SYSTEM_INFO) + StrSize (Instance->VolumeLabel) - sizeof (CHAR16);\r
\r
    if (*BufferSize < Size) {\r
      *BufferSize = Size;\r
      return EFI_BUFFER_TOO_SMALL;\r
    }\r
\r
    //\r
    // Cast output buffer for convenience\r
    //\r
    FsInfoOut = (EFI_FILE_SYSTEM_INFO *) Buffer;\r
\r
    CopyMem (FsInfoOut, &mFsInfoTemplate, sizeof (EFI_FILE_SYSTEM_INFO));\r
    Status = StrnCpyS ( FsInfoOut->VolumeLabel,\r
                        (*BufferSize - OFFSET_OF (EFI_FILE_SYSTEM_INFO, VolumeLabel)) / sizeof (CHAR16),\r
                        Instance->VolumeLabel,\r
                        StrLen (Instance->VolumeLabel)\r
                        );\r
    ASSERT_EFI_ERROR (Status);\r
    FsInfoOut->Size = Size;\r
    return Status;\r
  } else if (CompareGuid (InformationType, &gEfiFileInfoGuid)) {\r
    //\r
    // Return file info\r
    //\r
    return FvFsGetFileInfo (File->FvFileInfo, BufferSize, (EFI_FILE_INFO *) Buffer);\r
  } else if (CompareGuid (InformationType, &gEfiFileSystemVolumeLabelInfoIdGuid)) {\r
    //\r
    // Return Volume Label\r
    //\r
    Instance = File->Instance;\r
    Size     = sizeof (EFI_FILE_SYSTEM_VOLUME_LABEL) + StrSize (Instance->VolumeLabel) - sizeof (CHAR16);;\r
    if (*BufferSize < Size) {\r
      *BufferSize = Size;\r
      return EFI_BUFFER_TOO_SMALL;\r
    }\r
\r
    FsVolumeLabel = (EFI_FILE_SYSTEM_VOLUME_LABEL*) Buffer;\r
    Status        = StrnCpyS (FsVolumeLabel->VolumeLabel,\r
                              (*BufferSize - OFFSET_OF (EFI_FILE_SYSTEM_VOLUME_LABEL, VolumeLabel)) / sizeof (CHAR16),\r
                              Instance->VolumeLabel,\r
                              StrLen (Instance->VolumeLabel)\r
                              );\r
    ASSERT_EFI_ERROR (Status);\r
    return Status;\r
  } else {\r
    return EFI_UNSUPPORTED;\r
  }\r
}\r
\r
/**\r
  Sets information about a file.\r
\r
  @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the file\r
                          handle the information is for.\r
  @param  InformationType The type identifier for the information being set.\r
  @param  BufferSize      The size, in bytes, of Buffer.\r
  @param  Buffer          A pointer to the data buffer to write. The buffer's type is\r
                          indicated by InformationType.\r
\r
  @retval EFI_SUCCESS          The information was set.\r
  @retval EFI_UNSUPPORTED      The InformationType is not known.\r
  @retval EFI_NO_MEDIA         The device has no medium.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  InformationType is EFI_FILE_INFO_ID and the media is\r
                               read-only.\r
  @retval EFI_WRITE_PROTECTED  InformationType is EFI_FILE_PROTOCOL_SYSTEM_INFO_ID\r
                               and the media is read only.\r
  @retval EFI_WRITE_PROTECTED  InformationType is EFI_FILE_SYSTEM_VOLUME_LABEL_ID\r
                               and the media is read-only.\r
  @retval EFI_ACCESS_DENIED    An attempt is made to change the name of a file to a\r
                               file that is already present.\r
  @retval EFI_ACCESS_DENIED    An attempt is being made to change the EFI_FILE_DIRECTORY\r
                               Attribute.\r
  @retval EFI_ACCESS_DENIED    An attempt is being made to change the size of a directory.\r
  @retval EFI_ACCESS_DENIED    InformationType is EFI_FILE_INFO_ID and the file was opened\r
                               read-only and an attempt is being made to modify a field\r
                               other than Attribute.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
  @retval EFI_BAD_BUFFER_SIZE  BufferSize is smaller than the size of the type indicated\r
                               by InformationType.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvSimpleFileSystemSetInfo (\r
  IN EFI_FILE_PROTOCOL        *This,\r
  IN EFI_GUID                 *InformationType,\r
  IN UINTN                    BufferSize,\r
  IN VOID                     *Buffer\r
  )\r
{\r
  if (CompareGuid (InformationType, &gEfiFileSystemInfoGuid) ||\r
      CompareGuid (InformationType, &gEfiFileInfoGuid) ||\r
      CompareGuid (InformationType, &gEfiFileSystemVolumeLabelInfoIdGuid)) {\r
    return EFI_WRITE_PROTECTED;\r
  }\r
\r
  return EFI_UNSUPPORTED;\r
}\r
\r