ARM Packages: Replace tabs by spaces for indentation

[mirror_edk2.git] / ArmPlatformPkg / FileSystem / BootMonFs / BootMonFsDir.c

/** @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
#include "BootMonFsInternal.h"\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
  BOOTMON_FS_INSTANCE *Instance;\r
\r
  Instance = BOOTMON_FS_FROM_FS_THIS (This);\r
  if (Instance == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  *Root = &Instance->RootFile->File;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
UINT32\r
BootMonFsGetImageLength (\r
  IN BOOTMON_FS_FILE      *File\r
  )\r
{\r
  UINT32                   Index;\r
  UINT32                   FileSize;\r
  LIST_ENTRY              *RegionToFlushLink;\r
  BOOTMON_FS_FILE_REGION  *Region;\r
\r
  FileSize = 0;\r
\r
  // Look at all Flash areas to determine file size\r
  for (Index = 0; Index < HW_IMAGE_DESCRIPTION_REGION_MAX; Index++) {\r
    FileSize += File->HwDescription.Region[Index].Size;\r
  }\r
\r
  // Add the regions that have not been flushed yet\r
  for (RegionToFlushLink = GetFirstNode (&File->RegionToFlushLink);\r
       !IsNull (&File->RegionToFlushLink, RegionToFlushLink);\r
       RegionToFlushLink = GetNextNode (&File->RegionToFlushLink, RegionToFlushLink)\r
       )\r
  {\r
    Region = (BOOTMON_FS_FILE_REGION*)RegionToFlushLink;\r
    if (Region->Offset + Region->Size > FileSize) {\r
      FileSize += Region->Offset + Region->Size;\r
    }\r
  }\r
\r
  return FileSize;\r
}\r
\r
UINTN\r
BootMonFsGetPhysicalSize (\r
  IN BOOTMON_FS_FILE* File\r
  )\r
{\r
  // Return 0 for files that haven't yet been flushed to media\r
  if (File->HwDescription.RegionCount == 0) {\r
    return 0;\r
  }\r
\r
  return ((File->HwDescription.BlockEnd - File->HwDescription.BlockStart) + 1 )\r
          * File->Instance->Media->BlockSize;\r
}\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsSetDirPosition (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN UINT64             Position\r
  )\r
{\r
  BOOTMON_FS_FILE       *File;\r
\r
  File = BOOTMON_FS_FILE_FROM_FILE_THIS (This);\r
  if (File == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // UEFI Spec section 12.5:\r
  // "The seek request for nonzero is not valid on open directories."\r
  if (Position != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  File->Position = Position;\r
\r
  return EFI_SUCCESS;\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
  ASSERT(0);\r
\r
  return EFI_UNSUPPORTED;\r
}\r
EFI_STATUS\r
GetFileSystemVolumeLabelInfo (\r
  IN BOOTMON_FS_INSTANCE *Instance,\r
  IN OUT UINTN          *BufferSize,\r
  OUT VOID              *Buffer\r
  )\r
{\r
  UINTN                         Size;\r
  EFI_FILE_SYSTEM_VOLUME_LABEL *Label;\r
  EFI_STATUS                    Status;\r
\r
  Label = Buffer;\r
\r
  // Value returned by StrSize includes null terminator.\r
  Size = SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL\r
         + StrSize (Instance->FsInfo.VolumeLabel);\r
\r
  if (*BufferSize >= Size) {\r
    CopyMem (&Label->VolumeLabel, &Instance->FsInfo.VolumeLabel, Size);\r
    Status = EFI_SUCCESS;\r
  } else {\r
    Status = EFI_BUFFER_TOO_SMALL;\r
  }\r
  *BufferSize = Size;\r
  return Status;\r
}\r
\r
// Helper function that calculates a rough "free space" by:\r
// - Taking the media size\r
// - Subtracting the sum of all file sizes\r
// - Subtracting the block size times the number of files\r
//    (To account for the blocks containing the HW_IMAGE_INFO\r
STATIC\r
UINT64\r
ComputeFreeSpace (\r
  IN BOOTMON_FS_INSTANCE *Instance\r
  )\r
{\r
  LIST_ENTRY   *FileLink;\r
  UINT64        FileSizeSum;\r
  UINT64        MediaSize;\r
  UINTN         NumFiles;\r
  EFI_BLOCK_IO_MEDIA *Media;\r
  BOOTMON_FS_FILE *File;\r
\r
  Media = Instance->BlockIo->Media;\r
  MediaSize = Media->BlockSize * (Media->LastBlock + 1);\r
\r
  NumFiles = 0;\r
  FileSizeSum = 0;\r
  for (FileLink = GetFirstNode (&Instance->RootFile->Link);\r
         !IsNull (&Instance->RootFile->Link, FileLink);\r
         FileLink = GetNextNode (&Instance->RootFile->Link, FileLink)\r
         )\r
  {\r
    File = BOOTMON_FS_FILE_FROM_LINK_THIS (FileLink);\r
    FileSizeSum += BootMonFsGetImageLength (File);\r
\r
    NumFiles++;\r
  }\r
\r
  return MediaSize - (FileSizeSum + (Media->BlockSize + NumFiles));\r
}\r
\r
EFI_STATUS\r
GetFilesystemInfo (\r
  IN BOOTMON_FS_INSTANCE *Instance,\r
  IN OUT UINTN          *BufferSize,\r
  OUT VOID              *Buffer\r
  )\r
{\r
  EFI_STATUS              Status;\r
\r
  if (*BufferSize >= Instance->FsInfo.Size) {\r
    Instance->FsInfo.FreeSpace = ComputeFreeSpace (Instance);\r
    CopyMem (Buffer, &Instance->FsInfo, Instance->FsInfo.Size);\r
    Status = EFI_SUCCESS;\r
  } else {\r
    Status = EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *BufferSize = Instance->FsInfo.Size;\r
  return Status;\r
}\r
\r
EFI_STATUS\r
GetFileInfo (\r
  IN BOOTMON_FS_INSTANCE *Instance,\r
  IN BOOTMON_FS_FILE     *File,\r
  IN OUT UINTN           *BufferSize,\r
  OUT VOID               *Buffer\r
  )\r
{\r
  EFI_FILE_INFO   *Info;\r
  UINTN           ResultSize;\r
  UINTN           NameSize;\r
  UINTN           Index;\r
\r
  if (File == Instance->RootFile) {\r
    NameSize = 0;\r
    ResultSize = SIZE_OF_EFI_FILE_INFO + sizeof (CHAR16);\r
  } else {\r
    NameSize   = AsciiStrLen (File->HwDescription.Footer.Filename) + 1;\r
    ResultSize = SIZE_OF_EFI_FILE_INFO + (NameSize * sizeof (CHAR16));\r
  }\r
\r
  if (*BufferSize < ResultSize) {\r
    *BufferSize = ResultSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  Info = Buffer;\r
\r
  // Zero out the structure\r
  ZeroMem (Info, ResultSize);\r
\r
  // Fill in the structure\r
  Info->Size = ResultSize;\r
\r
  if (File == Instance->RootFile) {\r
    Info->Attribute    = EFI_FILE_READ_ONLY | EFI_FILE_DIRECTORY;\r
    Info->FileName[0]  = L'\0';\r
  } else {\r
    Info->FileSize     = BootMonFsGetImageLength (File);\r
    Info->PhysicalSize = BootMonFsGetPhysicalSize (File);\r
\r
    for (Index = 0; Index < NameSize; Index++) {\r
      Info->FileName[Index] = File->HwDescription.Footer.Filename[Index];\r
    }\r
  }\r
\r
  *BufferSize = ResultSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
SetFileName (\r
  IN  BOOTMON_FS_FILE *File,\r
  IN  CHAR16          *FileNameUnicode\r
  )\r
{\r
  CHAR8                 *FileNameAscii;\r
  UINT16                 SavedChar;\r
  UINTN                  FileNameSize;\r
  BOOTMON_FS_FILE       *SameFile;\r
  EFI_STATUS             Status;\r
\r
  // EFI Shell inserts '\' in front of the filename that must be stripped\r
  if (FileNameUnicode[0] == L'\\') {\r
    FileNameUnicode++;\r
  }\r
  //\r
  // Convert Unicode into Ascii\r
  //\r
  SavedChar = L'\0';\r
  FileNameSize = StrLen (FileNameUnicode) + 1;\r
  FileNameAscii = AllocatePool (FileNameSize * sizeof (CHAR8));\r
  if (FileNameAscii == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  // If Unicode string is too long then truncate it.\r
  if (FileNameSize > MAX_NAME_LENGTH) {\r
    SavedChar = FileNameUnicode[MAX_NAME_LENGTH - 1];\r
    FileNameUnicode[MAX_NAME_LENGTH - 1] = L'\0';\r
  }\r
  UnicodeStrToAsciiStr (FileNameUnicode, FileNameAscii);\r
  // If the unicode string was truncated then restore its original content.\r
  if (SavedChar != L'\0') {\r
    FileNameUnicode[MAX_NAME_LENGTH - 1] = SavedChar;\r
  }\r
\r
  // If we're changing the file name\r
  if (AsciiStrCmp (FileNameAscii, File->HwDescription.Footer.Filename) == 0) {\r
    // No change to filename.\r
    Status = EFI_SUCCESS;\r
  } else if (!(File->OpenMode & EFI_FILE_MODE_WRITE)) {\r
    // You can only change the filename if you open the file for write.\r
    Status = EFI_ACCESS_DENIED;\r
  } else if (BootMonGetFileFromAsciiFileName (\r
                File->Instance,\r
                File->HwDescription.Footer.Filename,\r
                &SameFile) != EFI_NOT_FOUND) {\r
    // A file with that name already exists.\r
    Status = EFI_ACCESS_DENIED;\r
  } else {\r
    // OK, change the filename.\r
    AsciiStrCpy (FileNameAscii, File->HwDescription.Footer.Filename);\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  FreePool (FileNameAscii);\r
  return Status;\r
}\r
\r
// Set the file's size (NB "size", not "physical size"). If the change amounts\r
// to an increase, simply do a write followed by a flush.\r
// (This is a helper function for SetFileInfo.)\r
STATIC\r
EFI_STATUS\r
SetFileSize (\r
  IN BOOTMON_FS_INSTANCE *Instance,\r
  IN BOOTMON_FS_FILE     *BootMonFsFile,\r
  IN UINTN                NewSize\r
  )\r
{\r
  UINT64             StoredPosition;\r
  EFI_STATUS         Status;\r
  EFI_FILE_PROTOCOL *File;\r
  CHAR8              Buffer;\r
  UINTN              BufferSize;\r
  UINT32             OldSize;\r
\r
  OldSize = BootMonFsFile->HwDescription.Region[0].Size;\r
\r
  if (OldSize == NewSize) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Buffer = 0;\r
  BufferSize = sizeof (Buffer);\r
\r
  File = &BootMonFsFile->File;\r
\r
  if (!(BootMonFsFile->OpenMode & EFI_FILE_MODE_WRITE)) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
\r
  if (NewSize <= OldSize) {\r
    OldSize = NewSize;\r
  } else {\r
    // Increasing a file's size is potentially complicated as it may require\r
    // moving the image description on media. The simplest way to do it is to\r
    // seek past the end of the file (which is valid in UEFI) and perform a\r
    // Write.\r
\r
    // Save position\r
    Status = File->GetPosition (File, &StoredPosition);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Status = File->SetPosition (File, NewSize - 1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    Status = File->Write (File, &BufferSize, &Buffer);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    // Restore saved position\r
    Status = File->SetPosition (File, NewSize - 1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Status = File->Flush (File);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
SetFileInfo (\r
  IN BOOTMON_FS_INSTANCE *Instance,\r
  IN BOOTMON_FS_FILE     *File,\r
  IN UINTN                BufferSize,\r
  IN EFI_FILE_INFO       *Info\r
  )\r
{\r
  EFI_STATUS             Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  // Note that a call to this function on a file opened read-only is only\r
  // invalid if it actually changes fields, so  we don't immediately fail if the\r
  // OpenMode is wrong.\r
  // Also note that the only fields supported are filename and size, others are\r
  // ignored.\r
\r
  if (File != Instance->RootFile) {\r
    if (!(File->OpenMode & EFI_FILE_MODE_WRITE)) {\r
      return EFI_ACCESS_DENIED;\r
    }\r
\r
    Status = SetFileName (File, Info->FileName);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    // Update file size\r
    Status = SetFileSize (Instance, File, Info->FileSize);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
  return Status;\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
  EFI_STATUS           Status;\r
  BOOTMON_FS_FILE     *File;\r
  BOOTMON_FS_INSTANCE *Instance;\r
\r
  File = BOOTMON_FS_FILE_FROM_FILE_THIS (This);\r
  if (File == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Instance = File->Instance;\r
\r
  // If the instance has not been initialized yet then do it ...\r
  if (!Instance->Initialized) {\r
    Status = BootMonFsInitialize (Instance);\r
  } else {\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    if (CompareGuid (InformationType, &gEfiFileSystemVolumeLabelInfoIdGuid)\r
        != 0) {\r
      Status = GetFileSystemVolumeLabelInfo (Instance, BufferSize, Buffer);\r
    } else if (CompareGuid (InformationType, &gEfiFileSystemInfoGuid) != 0) {\r
      Status = GetFilesystemInfo (Instance, BufferSize, Buffer);\r
    } else if (CompareGuid (InformationType, &gEfiFileInfoGuid) != 0) {\r
      Status = GetFileInfo (Instance, File, BufferSize, Buffer);\r
    } else {\r
      Status = EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return Status;\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
  EFI_STATUS           Status;\r
  BOOTMON_FS_FILE     *File;\r
  BOOTMON_FS_INSTANCE *Instance;\r
\r
  File = BOOTMON_FS_FILE_FROM_FILE_THIS (This);\r
  if (File == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Instance = File->Instance;\r
\r
  if (CompareGuid (InformationType, &gEfiFileInfoGuid) != 0) {\r
    Status = SetFileInfo (Instance, File, BufferSize, (EFI_FILE_INFO *) Buffer);\r
  } else {\r
    // The only writable field in the other two information types\r
    // (i.e. EFI_FILE_SYSTEM_INFO and EFI_FILE_SYSTEM_VOLUME_LABEL) is the\r
    // filesystem volume label. This can be retrieved with GetInfo, but it is\r
    // hard-coded into this driver, not stored on media.\r
    Status = EFI_UNSUPPORTED;\r
  }\r
\r
  return Status;\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
  BOOTMON_FS_INSTANCE *Instance;\r
  BOOTMON_FS_FILE     *RootFile;\r
  BOOTMON_FS_FILE     *File;\r
  EFI_FILE_INFO       *Info;\r
  UINTN               NameSize;\r
  UINTN               ResultSize;\r
  EFI_STATUS          Status;\r
  UINTN               Index;\r
\r
  RootFile = BOOTMON_FS_FILE_FROM_FILE_THIS (This);\r
  if (RootFile == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Instance = RootFile->Instance;\r
  Status = BootMonGetFileFromPosition (Instance, RootFile->Position, &File);\r
  if (EFI_ERROR (Status)) {\r
    // No more file\r
    *BufferSize = 0;\r
    return EFI_SUCCESS;\r
  }\r
\r
  NameSize   = AsciiStrLen (File->HwDescription.Footer.Filename) + 1;\r
  ResultSize = SIZE_OF_EFI_FILE_INFO + (NameSize * sizeof (CHAR16));\r
  if (*BufferSize < ResultSize) {\r
    *BufferSize = ResultSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  // Zero out the structure\r
  Info = Buffer;\r
  ZeroMem (Info, ResultSize);\r
\r
  // Fill in the structure\r
  Info->Size         = ResultSize;\r
  Info->FileSize     = BootMonFsGetImageLength (File);\r
  Info->PhysicalSize = BootMonFsGetPhysicalSize (File);\r
  for (Index = 0; Index < NameSize; Index++) {\r
    Info->FileName[Index] = File->HwDescription.Footer.Filename[Index];\r
  }\r
\r
  *BufferSize = ResultSize;\r
  RootFile->Position++;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFIAPI\r
EFI_STATUS\r
BootMonFsFlushDirectory (\r
  IN EFI_FILE_PROTOCOL  *This\r
  )\r
{\r
  BOOTMON_FS_FILE *RootFile;\r
  LIST_ENTRY      *ListFiles;\r
  LIST_ENTRY      *Link;\r
  BOOTMON_FS_FILE *File;\r
\r
  RootFile = BOOTMON_FS_FILE_FROM_FILE_THIS (This);\r
  if (RootFile == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ListFiles = &RootFile->Link;\r
\r
  if (IsListEmpty (ListFiles)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Flush all the files that need to be flushed\r
  //\r
\r
  // Go through all the list of files to flush them\r
  for (Link = GetFirstNode (ListFiles);\r
       !IsNull (ListFiles, Link);\r
       Link = GetNextNode (ListFiles, Link)\r
       )\r
  {\r
    File = BOOTMON_FS_FILE_FROM_LINK_THIS (Link);\r
    File->File.Flush (&File->File);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r