ArmPlatformPkg/BootMonFs: Fix the setting of information about a file

[mirror_edk2.git] / ArmPlatformPkg / FileSystem / BootMonFs / BootMonFsEntryPoint.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 <Library/BaseMemoryLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <Protocol/DevicePathFromText.h>\r
#include <Protocol/DriverBinding.h>\r
\r
#include "BootMonFsInternal.h"\r
\r
EFI_DEVICE_PATH* mBootMonFsSupportedDevicePaths;\r
LIST_ENTRY       mInstances;\r
\r
EFI_FILE_PROTOCOL mBootMonFsRootTemplate = {\r
  EFI_FILE_PROTOCOL_REVISION,\r
  BootMonFsOpenFile,\r
  BootMonFsCloseFile,\r
  BootMonFsDeleteFail,\r
  BootMonFsReadDirectory,\r
  BootMonFsWriteFile,\r
  BootMonFsGetPositionUnsupported,  // UEFI Spec: GetPosition not valid on dirs\r
  BootMonFsSetDirPosition,\r
  BootMonFsGetInfo,\r
  BootMonFsSetInfo,\r
  BootMonFsFlushDirectory\r
};\r
\r
EFI_FILE_PROTOCOL mBootMonFsFileTemplate = {\r
  EFI_FILE_PROTOCOL_REVISION,\r
  BootMonFsOpenFile,\r
  BootMonFsCloseFile,\r
  BootMonFsDelete,\r
  BootMonFsReadFile,\r
  BootMonFsWriteFile,\r
  BootMonFsGetPosition,\r
  BootMonFsSetPosition,\r
  BootMonFsGetInfo,\r
  BootMonFsSetInfo,\r
  BootMonFsFlushFile\r
};\r
\r
/**\r
  Search for a file given its name coded in Ascii.\r
\r
  When searching through the files of the volume, if a file is currently not\r
  open, its name was written on the media and is kept in RAM in the\r
  "HwDescription.Footer.Filename[]" field of the file's description.\r
\r
  If a file is currently open, its name might not have been written on the\r
  media yet, and as the "HwDescription" is a mirror in RAM of what is on the\r
  media the "HwDescription.Footer.Filename[]" might be outdated. In that case,\r
  the up to date name of the file is stored in the "Info" field of the file's\r
  description.\r
\r
  @param[in]   Instance       Pointer to the description of the volume in which\r
                              the file has to be search for.\r
  @param[in]   AsciiFileName  Name of the file.\r
\r
  @param[out]  File           Pointer to the description of the file if the\r
                              file was found.\r
\r
  @retval  EFI_SUCCESS    The file was found.\r
  @retval  EFI_NOT_FOUND  The file was not found.\r
\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
  LIST_ENTRY       *Entry;\r
  BOOTMON_FS_FILE  *FileEntry;\r
  CHAR8            OpenFileAsciiFileName[MAX_NAME_LENGTH];\r
  CHAR8            *AsciiFileNameToCompare;\r
\r
  // Go through all the files in the list and return the file handle\r
  for (Entry = GetFirstNode (&Instance->RootFile->Link);\r
       !IsNull (&Instance->RootFile->Link, Entry);\r
       Entry = GetNextNode (&Instance->RootFile->Link, Entry)\r
       )\r
  {\r
    FileEntry = BOOTMON_FS_FILE_FROM_LINK_THIS (Entry);\r
    if (FileEntry->Info != NULL) {\r
      UnicodeStrToAsciiStr (FileEntry->Info->FileName, OpenFileAsciiFileName);\r
      AsciiFileNameToCompare = OpenFileAsciiFileName;\r
    } else {\r
      AsciiFileNameToCompare = FileEntry->HwDescription.Footer.Filename;\r
    }\r
\r
    if (AsciiStrCmp (AsciiFileNameToCompare, AsciiFileName) == 0) {\r
      *File = FileEntry;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
  return EFI_NOT_FOUND;\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
  LIST_ENTRY        *Entry;\r
  BOOTMON_FS_FILE   *FileEntry;\r
\r
  // Go through all the files in the list and return the file handle\r
  for (Entry = GetFirstNode (&Instance->RootFile->Link);\r
       !IsNull (&Instance->RootFile->Link, Entry) && (&Instance->RootFile->Link != Entry);\r
       Entry = GetNextNode (&Instance->RootFile->Link, Entry)\r
       )\r
  {\r
    if (Position == 0) {\r
      FileEntry = BOOTMON_FS_FILE_FROM_LINK_THIS (Entry);\r
      *File = FileEntry;\r
      return EFI_SUCCESS;\r
    }\r
    Position--;\r
  }\r
  return EFI_NOT_FOUND;\r
}\r
\r
EFI_STATUS\r
BootMonFsCreateFile (\r
  IN  BOOTMON_FS_INSTANCE *Instance,\r
  OUT BOOTMON_FS_FILE     **File\r
  )\r
{\r
  BOOTMON_FS_FILE *NewFile;\r
\r
  NewFile = (BOOTMON_FS_FILE*)AllocateZeroPool (sizeof (BOOTMON_FS_FILE));\r
  if (NewFile == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  NewFile->Signature = BOOTMON_FS_FILE_SIGNATURE;\r
  InitializeListHead (&NewFile->Link);\r
  InitializeListHead (&NewFile->RegionToFlushLink);\r
  NewFile->Instance = Instance;\r
\r
  // If the created file is the root file then create a directory EFI_FILE_PROTOCOL\r
  if (Instance->RootFile == *File) {\r
    CopyMem (&NewFile->File, &mBootMonFsRootTemplate, sizeof (mBootMonFsRootTemplate));\r
  } else {\r
    CopyMem (&NewFile->File, &mBootMonFsFileTemplate, sizeof (mBootMonFsFileTemplate));\r
  }\r
  *File = NewFile;\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
SupportedDevicePathsInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  CHAR16*                             DevicePathListStr;\r
  CHAR16*                             DevicePathStr;\r
  CHAR16*                             NextDevicePathStr;\r
  EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *EfiDevicePathFromTextProtocol;\r
  EFI_DEVICE_PATH_PROTOCOL           *Instance;\r
\r
  Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  // Initialize Variable\r
  DevicePathListStr = (CHAR16*)PcdGetPtr (PcdBootMonFsSupportedDevicePaths);\r
  mBootMonFsSupportedDevicePaths = NULL;\r
\r
  // Extract the Device Path instances from the multi-device path string\r
  while ((DevicePathListStr != NULL) && (DevicePathListStr[0] != L'\0')) {\r
    NextDevicePathStr = StrStr (DevicePathListStr, L";");\r
    if (NextDevicePathStr == NULL) {\r
      DevicePathStr = DevicePathListStr;\r
      DevicePathListStr = NULL;\r
    } else {\r
      DevicePathStr = (CHAR16*)AllocateCopyPool ((NextDevicePathStr - DevicePathListStr + 1) * sizeof (CHAR16), DevicePathListStr);\r
      if (DevicePathStr == NULL) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
      *(DevicePathStr + (NextDevicePathStr - DevicePathListStr)) = L'\0';\r
      DevicePathListStr = NextDevicePathStr;\r
      if (DevicePathListStr[0] == L';') {\r
        DevicePathListStr++;\r
      }\r
    }\r
\r
    Instance = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath (DevicePathStr);\r
    ASSERT (Instance != NULL);\r
    mBootMonFsSupportedDevicePaths = AppendDevicePathInstance (mBootMonFsSupportedDevicePaths, Instance);\r
\r
    if (NextDevicePathStr != NULL) {\r
      FreePool (DevicePathStr);\r
    }\r
    FreePool (Instance);\r
  }\r
\r
  if (mBootMonFsSupportedDevicePaths == NULL) {\r
    return EFI_UNSUPPORTED;\r
  } else {\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
BootMonFsDriverSupported (\r
  IN        EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
  IN        EFI_HANDLE                   ControllerHandle,\r
  IN        EFI_DEVICE_PATH_PROTOCOL    *DevicePath OPTIONAL\r
  )\r
{\r
  EFI_DISK_IO_PROTOCOL  *DiskIo;\r
  EFI_DEVICE_PATH_PROTOCOL *DevicePathProtocol;\r
  EFI_DEVICE_PATH_PROTOCOL *SupportedDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL *SupportedDevicePaths;\r
  EFI_STATUS Status;\r
  UINTN Size1;\r
  UINTN Size2;\r
\r
  //\r
  // Open the IO Abstraction(s) needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDiskIoProtocolGuid,\r
                  (VOID **) &DiskIo,\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
         ControllerHandle,\r
         &gEfiDiskIoProtocolGuid,\r
         gImageHandle,\r
         ControllerHandle\r
         );\r
\r
  // Check that BlockIo protocol instance exists\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiBlockIoProtocolGuid,\r
                  NULL,\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Check if a DevicePath is attached to the handle\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **)&DevicePathProtocol,\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Check if the Device Path is the one which contains the Boot Monitor File System\r
  Size1 = GetDevicePathSize (DevicePathProtocol);\r
\r
  // Go through the list of Device Path Instances\r
  Status = EFI_UNSUPPORTED;\r
  SupportedDevicePaths = mBootMonFsSupportedDevicePaths;\r
  while (SupportedDevicePaths != NULL) {\r
    SupportedDevicePath = GetNextDevicePathInstance (&SupportedDevicePaths, &Size2);\r
\r
    if ((Size1 == Size2) && (CompareMem (DevicePathProtocol, SupportedDevicePath, Size1) == 0)) {\r
      // The Device Path is supported\r
      Status = EFI_SUCCESS;\r
      break;\r
    }\r
  }\r
\r
  gBS->CloseProtocol (ControllerHandle, &gEfiDevicePathProtocolGuid, gImageHandle, ControllerHandle);\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
BootMonFsDriverStart (\r
  IN        EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
  IN        EFI_HANDLE                   ControllerHandle,\r
  IN        EFI_DEVICE_PATH_PROTOCOL    *DevicePath OPTIONAL\r
  )\r
{\r
  BOOTMON_FS_INSTANCE *Instance;\r
  EFI_STATUS           Status;\r
  UINTN                VolumeNameSize;\r
  EFI_FILE_INFO       *Info;\r
\r
  Instance = AllocateZeroPool (sizeof (BOOTMON_FS_INSTANCE));\r
  if (Instance == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  // Initialize the BlockIo of the Instance\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiBlockIoProtocolGuid,\r
                  (VOID **)&(Instance->BlockIo),\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDiskIoProtocolGuid,\r
                  (VOID **)&(Instance->DiskIo),\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Initialize the attributes of the Instance\r
  //\r
  Instance->Signature = BOOTMON_FS_SIGNATURE;\r
  Instance->ControllerHandle = ControllerHandle;\r
  Instance->Media = Instance->BlockIo->Media;\r
  Instance->Binding = DriverBinding;\r
\r
    // Initialize the Simple File System Protocol\r
  Instance->Fs.Revision = EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION;\r
  Instance->Fs.OpenVolume = OpenBootMonFsOpenVolume;\r
\r
  // Volume name + L' ' + '2' digit number\r
  VolumeNameSize = StrSize (BOOTMON_FS_VOLUME_LABEL) + (3 * sizeof (CHAR16));\r
\r
  // Initialize FileSystem Information\r
  Instance->FsInfo.Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + VolumeNameSize;\r
  Instance->FsInfo.BlockSize = Instance->Media->BlockSize;\r
  Instance->FsInfo.ReadOnly = FALSE;\r
  Instance->FsInfo.VolumeSize =\r
    Instance->Media->BlockSize * (Instance->Media->LastBlock - Instance->Media->LowestAlignedLba);\r
  CopyMem (Instance->FsInfo.VolumeLabel, BOOTMON_FS_VOLUME_LABEL, StrSize (BOOTMON_FS_VOLUME_LABEL));\r
\r
  // Initialize the root file\r
  Status = BootMonFsCreateFile (Instance, &Instance->RootFile);\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  Info = AllocateZeroPool (sizeof (EFI_FILE_INFO));\r
  if (Info == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error;\r
  }\r
  Instance->RootFile->Info = Info;\r
\r
  // Initialize the DevicePath of the Instance\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **)&(Instance->DevicePath),\r
                  gImageHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Install the Simple File System Protocol\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                      &ControllerHandle,\r
                      &gEfiSimpleFileSystemProtocolGuid, &Instance->Fs,\r
                      NULL\r
                      );\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  InsertTailList (&mInstances, &Instance->Link);\r
\r
  return EFI_SUCCESS;\r
\r
Error:\r
\r
    if (Instance->RootFile != NULL) {\r
      if (Instance->RootFile->Info != NULL) {\r
        FreePool (Instance->RootFile->Info);\r
      }\r
      FreePool (Instance->RootFile);\r
    }\r
    FreePool (Instance);\r
\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
BootMonFsDriverStop (\r
  IN        EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,\r
  IN        EFI_HANDLE                   ControllerHandle,\r
  IN        UINTN                        NumberOfChildren,\r
  IN        EFI_HANDLE                  *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  BOOTMON_FS_INSTANCE *Instance;\r
  LIST_ENTRY          *Link;\r
  EFI_STATUS           Status;\r
  BOOLEAN              InstanceFound;\r
\r
  // Find instance from ControllerHandle.\r
  Instance = NULL;\r
  InstanceFound = FALSE;\r
  // For each instance in mInstances:\r
  for (Link = GetFirstNode (&mInstances); !IsNull (&mInstances, Link); Link = GetNextNode (&mInstances, Link)) {\r
    Instance = BOOTMON_FS_FROM_LINK (Link);\r
\r
    if (Instance->ControllerHandle == ControllerHandle) {\r
      InstanceFound = TRUE;\r
      break;\r
    }\r
  }\r
  ASSERT (InstanceFound == TRUE);\r
\r
  gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiDevicePathProtocolGuid,\r
      DriverBinding->ImageHandle,\r
      ControllerHandle);\r
\r
  gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiDiskIoProtocolGuid,\r
      DriverBinding->ImageHandle,\r
      ControllerHandle);\r
\r
  gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiBlockIoProtocolGuid,\r
      DriverBinding->ImageHandle,\r
      ControllerHandle);\r
\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
      &ControllerHandle,\r
      &gEfiSimpleFileSystemProtocolGuid, &Instance->Fs,\r
      NULL);\r
\r
  FreePool (Instance->RootFile->Info);\r
  FreePool (Instance->RootFile);\r
  FreePool (Instance);\r
\r
  return Status;\r
}\r
\r
//\r
// Simple Network Protocol Driver Global Variables\r
//\r
EFI_DRIVER_BINDING_PROTOCOL mBootMonFsDriverBinding = {\r
  BootMonFsDriverSupported,\r
  BootMonFsDriverStart,\r
  BootMonFsDriverStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
BootMonFsEntryPoint (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  InitializeListHead (&mInstances);\r
\r
  // Initialize the list of Device Paths that could support BootMonFs\r
  Status = SupportedDevicePathsInit ();\r
  if (!EFI_ERROR (Status)) {\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                    &ImageHandle,\r
                    &gEfiDriverBindingProtocolGuid, &mBootMonFsDriverBinding,\r
                    NULL\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
  } else {\r
    DEBUG((EFI_D_ERROR,"Warning: No Device Paths supporting BootMonFs have been defined in the PCD.\n"));\r
  }\r
\r
  return Status;\r
}\r