Patch from open source community for CryptoPkg to allow it to build for ARM using...

[mirror_edk2.git] / ArmPkg / Filesystem / SemihostFs / Arm / SemihostFs.c

/** @file\r
  Support a Semi Host file system over a debuggers JTAG\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\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 <Uefi.h>\r
\r
#include <Guid/FileInfo.h>\r
#include <Guid/FileSystemInfo.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h> \r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/SemihostLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleFileSystem.h>\r
\r
#include "SemihostFs.h"\r
\r
\r
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL gSemihostFs = {\r
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION,\r
  VolumeOpen\r
};\r
\r
EFI_FILE gSemihostFsFile = {\r
  EFI_FILE_PROTOCOL_REVISION,\r
  FileOpen,\r
  FileClose,\r
  FileDelete,\r
  FileRead,\r
  FileWrite,\r
  FileGetPosition,\r
  FileSetPosition,\r
  FileGetInfo,\r
  FileSetInfo,\r
  FileFlush\r
};\r
\r
//\r
// Device path for SemiHosting. It contains our autogened Caller ID GUID.\r
//\r
typedef struct {\r
  VENDOR_DEVICE_PATH        Guid;\r
  EFI_DEVICE_PATH_PROTOCOL  End;\r
} SEMIHOST_DEVICE_PATH;\r
\r
SEMIHOST_DEVICE_PATH gDevicePath = {\r
  {\r
    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0 },\r
    EFI_CALLER_ID_GUID\r
  },\r
  { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}\r
};\r
\r
typedef struct {\r
  LIST_ENTRY  Link;\r
  UINT64      Signature;\r
  EFI_FILE    File;\r
  CHAR8       *FileName;\r
  UINT32      Position;\r
  UINT32      SemihostHandle;\r
  BOOLEAN     IsRoot;\r
} SEMIHOST_FCB;\r
\r
#define SEMIHOST_FCB_SIGNATURE      SIGNATURE_32( 'S', 'H', 'F', 'C' )\r
#define SEMIHOST_FCB_FROM_THIS(a)   CR(a, SEMIHOST_FCB, File, SEMIHOST_FCB_SIGNATURE)\r
#define SEMIHOST_FCB_FROM_LINK(a)   CR(a, SEMIHOST_FCB, Link, SEMIHOST_FCB_SIGNATURE);\r
\r
EFI_HANDLE  gInstallHandle = NULL;\r
LIST_ENTRY  gFileList = INITIALIZE_LIST_HEAD_VARIABLE (gFileList);\r
\r
SEMIHOST_FCB *\r
AllocateFCB (\r
  VOID\r
  )\r
{\r
  SEMIHOST_FCB *Fcb = AllocateZeroPool (sizeof (SEMIHOST_FCB));\r
\r
  if (Fcb != NULL) {\r
    CopyMem (&Fcb->File, &gSemihostFsFile, sizeof (gSemihostFsFile));\r
    Fcb->Signature = SEMIHOST_FCB_SIGNATURE;\r
  }\r
\r
  return Fcb;\r
}\r
\r
VOID\r
FreeFCB (\r
  IN SEMIHOST_FCB *Fcb\r
  )\r
{\r
  // Remove Fcb from gFileList.\r
  RemoveEntryList (&Fcb->Link);\r
\r
  // To help debugging...\r
  Fcb->Signature = 0;\r
\r
  FreePool (Fcb);\r
}\r
\r
\r
\r
EFI_STATUS\r
VolumeOpen (\r
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
  OUT EFI_FILE                        **Root\r
  )\r
{\r
  SEMIHOST_FCB *RootFcb = NULL;\r
  \r
  if (Root == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  RootFcb = AllocateFCB ();\r
  if (RootFcb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  \r
  RootFcb->IsRoot = TRUE;\r
\r
  InsertTailList (&gFileList, &RootFcb->Link);\r
\r
  *Root = &RootFcb->File;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
FileOpen (\r
  IN  EFI_FILE    *File,\r
  OUT EFI_FILE    **NewHandle,\r
  IN  CHAR16      *FileName,\r
  IN  UINT64      OpenMode,\r
  IN  UINT64      Attributes\r
  )\r
{\r
  SEMIHOST_FCB  *FileFcb = NULL;\r
  EFI_STATUS    Status   = EFI_SUCCESS;\r
  UINT32        SemihostHandle;\r
  CHAR8         *AsciiFileName;\r
  CHAR8         *AsciiPtr;\r
  UINTN         Length;\r
  UINT32        SemihostMode;\r
  BOOLEAN       IsRoot;\r
\r
  if ((FileName == NULL) || (NewHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // Semihost interface requires ASCII filesnames\r
  Length = StrSize (FileName);\r
\r
  AsciiFileName = AllocatePool (Length);\r
  if (AsciiFileName == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  AsciiPtr = AsciiFileName;\r
\r
  while (Length--) {\r
    *AsciiPtr++ = *FileName++ & 0xFF;\r
  }\r
\r
  if ((AsciiStrCmp (AsciiFileName, "\\") == 0) || (AsciiStrCmp (AsciiFileName, "/") == 0) || (AsciiStrCmp (AsciiFileName, "") == 0)) {\r
    // Opening '/', '\', or the NULL pathname is trying to open the root directory\r
    IsRoot = TRUE;\r
\r
    // Root directory node doesn't have a name.\r
    FreePool (AsciiFileName);\r
    AsciiFileName = NULL;\r
  } else {\r
    // Translate EFI_FILE_MODE into Semihosting mode\r
    if (OpenMode & EFI_FILE_MODE_WRITE) {\r
      SemihostMode = SEMIHOST_FILE_MODE_WRITE | SEMIHOST_FILE_MODE_BINARY;\r
    } else if (OpenMode & EFI_FILE_MODE_READ) {\r
      SemihostMode = SEMIHOST_FILE_MODE_READ  | SEMIHOST_FILE_MODE_BINARY;\r
    } else {\r
      return EFI_UNSUPPORTED;\r
    }\r
\r
    // Add the creation flag if necessary\r
    if (OpenMode & EFI_FILE_MODE_CREATE) {\r
      SemihostMode |= SEMIHOST_FILE_MODE_CREATE;\r
    }\r
\r
    // Call the semihosting interface to open the file.\r
    Status = SemihostFileOpen (AsciiFileName, SemihostMode, &SemihostHandle);\r
    if (EFI_ERROR(Status)) {\r
      return Status;\r
    }\r
    \r
    IsRoot = FALSE;\r
  }\r
\r
  // Allocate a control block and fill it\r
  FileFcb = AllocateFCB ();\r
  if (FileFcb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  FileFcb->FileName       = AsciiFileName;\r
  FileFcb->SemihostHandle = SemihostHandle;\r
  FileFcb->Position       = 0;\r
  FileFcb->IsRoot         = IsRoot;\r
\r
  InsertTailList (&gFileList, &FileFcb->Link);\r
\r
  *NewHandle = &FileFcb->File;\r
\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
FileClose (\r
  IN EFI_FILE *File\r
  )\r
{\r
  SEMIHOST_FCB *Fcb    = NULL;\r
  EFI_STATUS   Status  = EFI_SUCCESS;\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  if (Fcb->IsRoot == TRUE) {\r
    FreeFCB (Fcb);\r
    Status = EFI_SUCCESS;\r
  } else {\r
    Status = SemihostFileClose (Fcb->SemihostHandle);\r
    if (!EFI_ERROR(Status)) {\r
      FreePool (Fcb->FileName);\r
      FreeFCB (Fcb);\r
    }\r
  }\r
  \r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileDelete (\r
  IN EFI_FILE *File\r
  )\r
{\r
  SEMIHOST_FCB *Fcb = NULL;\r
  EFI_STATUS   Status;\r
  CHAR8        *FileName;\r
  UINTN        NameSize;\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  // Get the filename from the Fcb\r
  NameSize = AsciiStrLen (Fcb->FileName);\r
  FileName = AllocatePool (NameSize + 1);\r
\r
  AsciiStrCpy (FileName, Fcb->FileName);\r
\r
  // Close the file if it's open.  Disregard return status,\r
  // since it might give an error if the file isn't open.\r
  File->Close (File);\r
    \r
  // Call the semihost interface to delete the file.\r
  Status = SemihostFileRemove (FileName);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileRead (\r
  IN     EFI_FILE *File,\r
  IN OUT UINTN    *BufferSize,\r
  OUT    VOID     *Buffer\r
  )\r
{\r
  SEMIHOST_FCB *Fcb = NULL;\r
  EFI_STATUS   Status;\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  if (Fcb->IsRoot == TRUE) {\r
    Status = EFI_UNSUPPORTED;\r
  } else {\r
    Status = SemihostFileRead (Fcb->SemihostHandle, BufferSize, Buffer);\r
    if (!EFI_ERROR (Status)) {\r
      Fcb->Position += *BufferSize;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileWrite (\r
  IN     EFI_FILE *File,\r
  IN OUT UINTN    *BufferSize,\r
  IN     VOID     *Buffer\r
  )\r
{\r
  SEMIHOST_FCB *Fcb    = NULL;\r
  EFI_STATUS   Status;\r
  UINTN        WriteSize = *BufferSize;\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  Status = SemihostFileWrite (Fcb->SemihostHandle, &WriteSize, Buffer);\r
\r
  if (!EFI_ERROR(Status)) {\r
    // Semihost write return the number of bytes *NOT* written.\r
    *BufferSize -= WriteSize;\r
    Fcb->Position += *BufferSize;\r
  }\r
  \r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileGetPosition (\r
  IN  EFI_FILE    *File,\r
  OUT UINT64      *Position\r
  )\r
{\r
  SEMIHOST_FCB *Fcb = NULL;\r
    \r
  if (Position == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  *Position = Fcb->Position;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
FileSetPosition (\r
  IN EFI_FILE *File,\r
  IN UINT64   Position\r
  )\r
{\r
  SEMIHOST_FCB *Fcb    = NULL;\r
  UINT32       Length;\r
  EFI_STATUS   Status;\r
\r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
\r
  Status = SemihostFileLength (Fcb->SemihostHandle, &Length);\r
  if (!EFI_ERROR(Status) && (Length < Position)) {\r
    Position = Length;\r
  }\r
\r
  Status = SemihostFileSeek (Fcb->SemihostHandle, (UINT32)Position);\r
  if (!EFI_ERROR(Status)) {\r
    Fcb->Position = Position;\r
  }\r
\r
  return Status;\r
}\r
\r
STATIC\r
EFI_STATUS\r
GetFileInfo (\r
  IN     SEMIHOST_FCB  *Fcb,\r
  IN OUT UINTN        *BufferSize,\r
  OUT    VOID         *Buffer\r
  )\r
{\r
  EFI_FILE_INFO   *Info = NULL;\r
  UINTN           NameSize = 0;\r
  UINTN           ResultSize;\r
  UINTN           Index;\r
  UINT32          Length;\r
  EFI_STATUS      Status;\r
\r
  if (Fcb->IsRoot == TRUE) {\r
    ResultSize = SIZE_OF_EFI_FILE_INFO + sizeof(CHAR16);\r
  } else {\r
    NameSize   = AsciiStrLen (Fcb->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, SIZE_OF_EFI_FILE_INFO);\r
\r
  // Fill in the structure\r
  Info->Size = ResultSize;\r
\r
  if (Fcb->IsRoot == TRUE) {\r
    Info->Attribute    = EFI_FILE_READ_ONLY | EFI_FILE_DIRECTORY;\r
    Info->FileName[0]  = L'\0';\r
  } else {\r
    Status = SemihostFileLength (Fcb->SemihostHandle, &Length);\r
    if (EFI_ERROR(Status)) {\r
      return Status;\r
    }\r
\r
    Info->FileSize     = Length;\r
    Info->PhysicalSize = Length;\r
\r
    for (Index = 0; Index < NameSize; Index++) {\r
      Info->FileName[Index] = Fcb->FileName[Index];            \r
    }\r
  }\r
\r
\r
  *BufferSize = ResultSize;    \r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
GetFilesystemInfo (\r
  IN     SEMIHOST_FCB *Fcb,\r
  IN OUT UINTN        *BufferSize,\r
  OUT    VOID         *Buffer\r
  )\r
{\r
  EFI_FILE_SYSTEM_INFO    *Info = NULL;\r
  EFI_STATUS              Status;\r
  STATIC CHAR16           Label[] = L"SemihostFs";\r
  UINTN                   ResultSize = SIZE_OF_EFI_FILE_SYSTEM_INFO + StrSize(Label);\r
    \r
  if(*BufferSize >= ResultSize) {\r
    ZeroMem (Buffer, ResultSize);\r
    Status = EFI_SUCCESS;\r
        \r
    Info = Buffer;\r
\r
    Info->Size       = ResultSize;\r
    Info->ReadOnly   = FALSE;\r
    Info->VolumeSize = 0;\r
    Info->FreeSpace  = 0;\r
    Info->BlockSize  = 0;\r
\r
    StrCpy (Info->VolumeLabel, Label);\r
  } else {\r
    Status = EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *BufferSize = ResultSize;    \r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileGetInfo (\r
  IN     EFI_FILE *File,\r
  IN     EFI_GUID *InformationType,\r
  IN OUT UINTN    *BufferSize,\r
  OUT    VOID     *Buffer\r
  )\r
{\r
  SEMIHOST_FCB *Fcb = NULL;\r
  EFI_STATUS   Status = EFI_UNSUPPORTED;\r
  \r
  Fcb = SEMIHOST_FCB_FROM_THIS(File);\r
  \r
  if (CompareGuid(InformationType, &gEfiFileSystemInfoGuid) != 0) {\r
    Status = GetFilesystemInfo(Fcb, BufferSize, Buffer);  \r
  } else if (CompareGuid(InformationType, &gEfiFileInfoGuid) != 0) {\r
    Status = GetFileInfo(Fcb, BufferSize, Buffer);  \r
  }\r
    \r
  return Status;\r
}\r
\r
EFI_STATUS\r
FileSetInfo (\r
  IN EFI_FILE *File,\r
  IN EFI_GUID *InformationType,\r
  IN UINTN    BufferSize,\r
  IN VOID     *Buffer\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_STATUS\r
FileFlush (\r
  IN EFI_FILE *File\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
SemihostFsEntryPoint (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS    Status = EFI_NOT_FOUND;\r
\r
  if (SemihostConnectionSupported ()) {\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                    &gInstallHandle, \r
                    &gEfiSimpleFileSystemProtocolGuid, &gSemihostFs, \r
                    &gEfiDevicePathProtocolGuid,       &gDevicePath,\r
                    NULL\r
                    );\r
  }\r
 \r
  return Status;\r
}\r
\r