ArmPkg: Fix Ecc error 8003

[mirror_edk2.git] / ArmPkg / Include / Library / SemihostLib.h

/** @file\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  Portions copyright (c) 2011, 2012, ARM Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef SEMIHOSTING_LIB_H_\r
#define SEMIHOSTING_LIB_H_\r
\r
/*\r
 *\r
 *  Please refer to ARM RVDS 3.0 Compiler and Libraries Guide for more information\r
 *  about the semihosting interface.\r
 *\r
 */\r
\r
#define SEMIHOST_FILE_MODE_READ     (0 << 2)\r
#define SEMIHOST_FILE_MODE_WRITE    (1 << 2)\r
#define SEMIHOST_FILE_MODE_APPEND   (2 << 2)\r
#define SEMIHOST_FILE_MODE_UPDATE   (1 << 1)\r
#define SEMIHOST_FILE_MODE_BINARY   (1 << 0)\r
#define SEMIHOST_FILE_MODE_ASCII    (0 << 0)\r
\r
BOOLEAN\r
SemihostConnectionSupported (\r
  VOID\r
  );\r
\r
RETURN_STATUS\r
SemihostFileOpen (\r
  IN  CHAR8  *FileName,\r
  IN  UINT32 Mode,\r
  OUT UINTN  *FileHandle\r
  );\r
\r
RETURN_STATUS\r
SemihostFileSeek (\r
  IN UINTN  FileHandle,\r
  IN UINTN  Offset\r
  );\r
\r
RETURN_STATUS\r
SemihostFileRead (\r
  IN     UINTN  FileHandle,\r
  IN OUT UINTN  *Length,\r
  OUT    VOID   *Buffer\r
  );\r
\r
RETURN_STATUS\r
SemihostFileWrite (\r
  IN     UINTN  FileHandle,\r
  IN OUT UINTN  *Length,\r
  IN     VOID   *Buffer\r
  );\r
\r
RETURN_STATUS\r
SemihostFileClose (\r
  IN UINTN  FileHandle\r
  );\r
\r
RETURN_STATUS\r
SemihostFileLength (\r
  IN  UINTN  FileHandle,\r
  OUT UINTN  *Length\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
RETURN_STATUS\r
SemihostFileRemove (\r
  IN CHAR8 *FileName\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
CHAR8\r
SemihostReadCharacter (\r
  VOID\r
  );\r
\r
VOID\r
SemihostWriteCharacter (\r
  IN CHAR8 Character\r
  );\r
\r
VOID\r
SemihostWriteString (\r
  IN CHAR8 *String\r
  );\r
\r
UINT32\r
SemihostSystem (\r
  IN CHAR8 *CommandLine\r
  );\r
\r
#endif // SEMIHOSTING_LIB_H_\r