ArmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPkg / Library / SemihostLib / SemihostLib.c

/** @file\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  Copyright (c) 2013 - 2014, ARM Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include <Base.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/SemihostLib.h>\r
\r
#include "SemihostPrivate.h"\r
\r
BOOLEAN\r
SemihostConnectionSupported (\r
  VOID\r
  )\r
{\r
  return SEMIHOST_SUPPORTED;\r
}\r
\r
RETURN_STATUS\r
SemihostFileOpen (\r
  IN  CHAR8  *FileName,\r
  IN  UINT32 Mode,\r
  OUT UINTN  *FileHandle\r
  )\r
{\r
  SEMIHOST_FILE_OPEN_BLOCK  OpenBlock;\r
  INT32                     Result;\r
\r
  if (FileHandle == NULL) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  // Remove any leading separator (e.g.: '\'). EFI Shell adds one.\r
  if (*FileName == '\\') {\r
    FileName++;\r
  }\r
\r
  OpenBlock.FileName    = FileName;\r
  OpenBlock.Mode        = Mode;\r
  OpenBlock.NameLength  = AsciiStrLen(FileName);\r
\r
  Result = Semihost_SYS_OPEN(&OpenBlock);\r
\r
  if (Result == -1) {\r
    return RETURN_NOT_FOUND;\r
  } else {\r
    *FileHandle = Result;\r
    return RETURN_SUCCESS;\r
  }\r
}\r
\r
RETURN_STATUS\r
SemihostFileSeek (\r
  IN UINTN  FileHandle,\r
  IN UINTN  Offset\r
  )\r
{\r
  SEMIHOST_FILE_SEEK_BLOCK  SeekBlock;\r
  INT32                     Result;\r
\r
  SeekBlock.Handle   = FileHandle;\r
  SeekBlock.Location = Offset;\r
\r
  Result = Semihost_SYS_SEEK(&SeekBlock);\r
\r
  // Semihosting does not behave as documented. It returns the offset on\r
  // success.\r
  if (Result < 0) {\r
    return RETURN_ABORTED;\r
  } else {\r
    return RETURN_SUCCESS;\r
  }\r
}\r
\r
RETURN_STATUS\r
SemihostFileRead (\r
  IN     UINTN  FileHandle,\r
  IN OUT UINTN  *Length,\r
  OUT    VOID   *Buffer\r
  )\r
{\r
  SEMIHOST_FILE_READ_WRITE_BLOCK  ReadBlock;\r
  UINT32                          Result;\r
\r
  if ((Length == NULL) || (Buffer == NULL)) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  ReadBlock.Handle = FileHandle;\r
  ReadBlock.Buffer = Buffer;\r
  ReadBlock.Length = *Length;\r
\r
  Result = Semihost_SYS_READ(&ReadBlock);\r
\r
  if ((*Length != 0) && (Result == *Length)) {\r
    return RETURN_ABORTED;\r
  } else {\r
    *Length -= Result;\r
    return RETURN_SUCCESS;\r
  }\r
}\r
\r
RETURN_STATUS\r
SemihostFileWrite (\r
  IN     UINTN  FileHandle,\r
  IN OUT UINTN  *Length,\r
  IN     VOID   *Buffer\r
  )\r
{\r
  SEMIHOST_FILE_READ_WRITE_BLOCK  WriteBlock;\r
\r
  if ((Length == NULL) || (Buffer == NULL)) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  WriteBlock.Handle = FileHandle;\r
  WriteBlock.Buffer = Buffer;\r
  WriteBlock.Length = *Length;\r
\r
  *Length = Semihost_SYS_WRITE(&WriteBlock);\r
\r
  if (*Length != 0)\r
    return RETURN_ABORTED;\r
  else\r
    return RETURN_SUCCESS;\r
}\r
\r
RETURN_STATUS\r
SemihostFileClose (\r
  IN UINTN  FileHandle\r
  )\r
{\r
  INT32 Result = Semihost_SYS_CLOSE(&FileHandle);\r
\r
  if (Result == -1) {\r
    return RETURN_INVALID_PARAMETER;\r
  } else {\r
    return RETURN_SUCCESS;\r
  }\r
}\r
\r
RETURN_STATUS\r
SemihostFileLength (\r
  IN  UINTN  FileHandle,\r
  OUT UINTN  *Length\r
  )\r
{\r
  INT32       Result;\r
\r
  if (Length == NULL) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  Result = Semihost_SYS_FLEN(&FileHandle);\r
\r
  if (Result == -1) {\r
    return RETURN_ABORTED;\r
  } else {\r
    *Length = Result;\r
    return RETURN_SUCCESS;\r
  }\r
}\r
\r
/**\r
  Get a temporary name for a file from the host running the debug agent.\r
\r
  @param[out]  Buffer      Pointer to the buffer where the temporary name has to\r
                           be stored\r
  @param[in]   Identifier  File name identifier (integer in the range 0 to 255)\r
  @param[in]   Length      Length of the buffer to store the temporary name\r
\r
  @retval  RETURN_SUCCESS            Temporary name returned\r
  @retval  RETURN_INVALID_PARAMETER  Invalid buffer address\r
  @retval  RETURN_ABORTED            Temporary name not returned\r
\r
**/\r
RETURN_STATUS\r
SemihostFileTmpName(\r
  OUT  VOID   *Buffer,\r
  IN   UINT8  Identifier,\r
  IN   UINTN  Length\r
  )\r
{\r
  SEMIHOST_FILE_TMPNAME_BLOCK  TmpNameBlock;\r
  INT32                        Result;\r
\r
  if (Buffer == NULL) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  TmpNameBlock.Buffer     = Buffer;\r
  TmpNameBlock.Identifier = Identifier;\r
  TmpNameBlock.Length     = Length;\r
\r
  Result = Semihost_SYS_TMPNAME (&TmpNameBlock);\r
\r
  if (Result != 0) {\r
    return  RETURN_ABORTED;\r
  } else {\r
    return  RETURN_SUCCESS;\r
  }\r
}\r
\r
RETURN_STATUS\r
SemihostFileRemove (\r
  IN CHAR8 *FileName\r
  )\r
{\r
  SEMIHOST_FILE_REMOVE_BLOCK  RemoveBlock;\r
  UINT32                      Result;\r
\r
  // Remove any leading separator (e.g.: '\'). EFI Shell adds one.\r
  if (*FileName == '\\') {\r
    FileName++;\r
  }\r
\r
  RemoveBlock.FileName    = FileName;\r
  RemoveBlock.NameLength  = AsciiStrLen(FileName);\r
\r
  Result = Semihost_SYS_REMOVE(&RemoveBlock);\r
\r
  if (Result == 0) {\r
    return RETURN_SUCCESS;\r
  } else {\r
    return RETURN_ABORTED;\r
  }\r
}\r
\r
/**\r
  Rename a specified file.\r
\r
  @param[in]  FileName     Name of the file to rename.\r
  @param[in]  NewFileName  The new name of the file.\r
\r
  @retval  RETURN_SUCCESS            File Renamed\r
  @retval  RETURN_INVALID_PARAMETER  Either the current or the new name is not specified\r
  @retval  RETURN_ABORTED            Rename failed\r
\r
**/\r
RETURN_STATUS\r
SemihostFileRename(\r
  IN  CHAR8  *FileName,\r
  IN  CHAR8  *NewFileName\r
  )\r
{\r
  SEMIHOST_FILE_RENAME_BLOCK  RenameBlock;\r
  INT32                       Result;\r
\r
  if ((FileName == NULL) || (NewFileName == NULL)) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  RenameBlock.FileName          = FileName;\r
  RenameBlock.FileNameLength    = AsciiStrLen (FileName);\r
  RenameBlock.NewFileName       = NewFileName;\r
  RenameBlock.NewFileNameLength = AsciiStrLen (NewFileName);\r
\r
  Result = Semihost_SYS_RENAME (&RenameBlock);\r
\r
  if (Result != 0) {\r
    return  RETURN_ABORTED;\r
  } else {\r
    return  RETURN_SUCCESS;\r
  }\r
}\r
\r
CHAR8\r
SemihostReadCharacter (\r
  VOID\r
  )\r
{\r
  return Semihost_SYS_READC();\r
}\r
\r
VOID\r
SemihostWriteCharacter (\r
  IN CHAR8 Character\r
  )\r
{\r
  Semihost_SYS_WRITEC(&Character);\r
}\r
\r
VOID\r
SemihostWriteString (\r
  IN CHAR8 *String\r
  )\r
{\r
  Semihost_SYS_WRITE0(String);\r
}\r
\r
UINT32\r
SemihostSystem (\r
  IN CHAR8 *CommandLine\r
  )\r
{\r
  SEMIHOST_SYSTEM_BLOCK SystemBlock;\r
\r
  SystemBlock.CommandLine   = CommandLine;\r
  SystemBlock.CommandLength = AsciiStrLen(CommandLine);\r
\r
  return Semihost_SYS_SYSTEM(&SystemBlock);\r
}\r