Functions
BOOLEAN	SemihostConnectionSupported (VOID)

RETURN_STATUS	SemihostFileOpen (IN CHAR8 FileName, IN UINT32 Mode, OUT UINTN FileHandle)

RETURN_STATUS	SemihostFileSeek (IN UINTN FileHandle, IN UINTN Offset)

RETURN_STATUS	SemihostFileRead (IN UINTN FileHandle, IN OUT UINTN Length, OUT VOID Buffer)

RETURN_STATUS	SemihostFileWrite (IN UINTN FileHandle, IN OUT UINTN Length, IN VOID Buffer)

RETURN_STATUS	SemihostFileClose (IN UINTN FileHandle)

RETURN_STATUS	SemihostFileLength (IN UINTN FileHandle, OUT UINTN *Length)

RETURN_STATUS	SemihostFileTmpName (OUT VOID *Buffer, IN UINT8 Identifier, IN UINTN Length)

RETURN_STATUS	SemihostFileRemove (IN CHAR8 *FileName)

RETURN_STATUS	SemihostFileRename (IN CHAR8 FileName, IN CHAR8 NewFileName)

CHAR8	SemihostReadCharacter (VOID)

VOID	SemihostWriteCharacter (IN CHAR8 Character)

VOID	SemihostWriteString (IN CHAR8 *String)

UINT32	SemihostSystem (IN CHAR8 *CommandLine)

Detailed Description

SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define SEMIHOST_FILE_MODE_APPEND (2 << 2)

#define SEMIHOST_FILE_MODE_ASCII (0 << 0)

#define SEMIHOST_FILE_MODE_BINARY (1 << 0)

#define SEMIHOST_FILE_MODE_READ (0 << 2)

#define SEMIHOST_FILE_MODE_UPDATE (1 << 1)

#define SEMIHOST_FILE_MODE_WRITE (1 << 2)

BOOLEAN SemihostConnectionSupported ( VOID )

RETURN_STATUS SemihostFileClose ( IN UINTN FileHandle )

RETURN_STATUS SemihostFileLength	(	IN UINTN	FileHandle,
		OUT UINTN *	Length
	)

RETURN_STATUS SemihostFileOpen	(	IN CHAR8 *	FileName,
		IN UINT32	Mode,
		OUT UINTN *	FileHandle
	)

RETURN_STATUS SemihostFileRead	(	IN UINTN	FileHandle,
		IN OUT UINTN *	Length,
		OUT VOID *	Buffer
	)

RETURN_STATUS SemihostFileRemove ( IN CHAR8 * FileName )

RETURN_STATUS SemihostFileRename	(	IN CHAR8 *	FileName,
		IN CHAR8 *	NewFileName
	)

Rename a specified file.

Parameters

[in]	FileName	Name of the file to rename.
[in]	NewFileName	The new name of the file.

Return values

RETURN_SUCCESS	File Renamed
RETURN_INVALID_PARAMETER	Either the current or the new name is not specified
RETURN_ABORTED	Rename failed

RETURN_STATUS SemihostFileSeek	(	IN UINTN	FileHandle,
		IN UINTN	Offset
	)

RETURN_STATUS SemihostFileTmpName	(	OUT VOID *	Buffer,
		IN UINT8	Identifier,
		IN UINTN	Length
	)

Get a temporary name for a file from the host running the debug agent.

Parameters

[out]	Buffer	Pointer to the buffer where the temporary name has to be stored
[in]	Identifier	File name identifier (integer in the range 0 to 255)
[in]	Length	Length of the buffer to store the temporary name

Return values

RETURN_STATUS SemihostFileWrite	(	IN UINTN	FileHandle,
		IN OUT UINTN *	Length,
		IN VOID *	Buffer
	)

CHAR8 SemihostReadCharacter ( VOID )

UINT32 SemihostSystem ( IN CHAR8 * CommandLine )

VOID SemihostWriteCharacter ( IN CHAR8 Character )

VOID SemihostWriteString ( IN CHAR8 * String )