mirror of
https://xff.cz/git/u-boot/
synced 2025-09-27 21:41:16 +02:00
3ea744e873
This adds three wrappers around the semihosting commands for reading and writing to the host console. We use the more standard getc/putc/puts names instead of readc/writec/write0 for familiarity. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
109 lines
2.8 KiB
C
109 lines
2.8 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Copyright (C) 2022 Sean Anderson <sean.anderson@seco.com>
|
|
*/
|
|
|
|
#ifndef _SEMIHOSTING_H
|
|
#define _SEMIHOSTING_H
|
|
|
|
/**
|
|
* enum smh_open_mode - Numeric file modes for use with smh_open()
|
|
* MODE_READ: 'r'
|
|
* MODE_BINARY: 'b'
|
|
* MODE_PLUS: '+'
|
|
* MODE_WRITE: 'w'
|
|
* MODE_APPEND: 'a'
|
|
*
|
|
* These modes represent the mode string used by fopen(3) in a form which can
|
|
* be passed to smh_open(). These do NOT correspond directly to %O_RDONLY,
|
|
* %O_CREAT, etc; see fopen(3) for details. In particular, @MODE_PLUS
|
|
* effectively results in adding %O_RDWR, and @MODE_WRITE will add %O_TRUNC.
|
|
* For compatibility, @MODE_BINARY should be added when opening non-text files
|
|
* (such as images).
|
|
*/
|
|
enum smh_open_mode {
|
|
MODE_READ = 0x0,
|
|
MODE_BINARY = 0x1,
|
|
MODE_PLUS = 0x2,
|
|
MODE_WRITE = 0x4,
|
|
MODE_APPEND = 0x8,
|
|
};
|
|
|
|
/**
|
|
* smh_open() - Open a file on the host
|
|
* @fname: The name of the file to open
|
|
* @mode: The mode to use when opening the file
|
|
*
|
|
* Return: Either a file descriptor or a negative error on failure
|
|
*/
|
|
long smh_open(const char *fname, enum smh_open_mode mode);
|
|
|
|
/**
|
|
* smh_read() - Read data from a file
|
|
* @fd: A file descriptor returned from smh_open()
|
|
* @memp: Pointer to a buffer of memory of at least @len bytes
|
|
* @len: The number of bytes to read
|
|
*
|
|
* Return:
|
|
* * The number of bytes read on success, with 0 indicating %EOF
|
|
* * A negative error on failure
|
|
*/
|
|
long smh_read(long fd, void *memp, size_t len);
|
|
|
|
/**
|
|
* smh_write() - Write data to a file
|
|
* @fd: A file descriptor returned from smh_open()
|
|
* @memp: Pointer to a buffer of memory of at least @len bytes
|
|
* @len: The number of bytes to read
|
|
* @written: Pointer which will be updated with the actual bytes written
|
|
*
|
|
* Return: 0 on success or negative error on failure
|
|
*/
|
|
long smh_write(long fd, const void *memp, size_t len, ulong *written);
|
|
|
|
/**
|
|
* smh_close() - Close an open file
|
|
* @fd: A file descriptor returned from smh_open()
|
|
*
|
|
* Return: 0 on success or negative error on failure
|
|
*/
|
|
long smh_close(long fd);
|
|
|
|
/**
|
|
* smh_flen() - Get the length of a file
|
|
* @fd: A file descriptor returned from smh_open()
|
|
*
|
|
* Return: The length of the file, in bytes, or a negative error on failure
|
|
*/
|
|
long smh_flen(long fd);
|
|
|
|
/**
|
|
* smh_seek() - Seek to a position in a file
|
|
* @fd: A file descriptor returned from smh_open()
|
|
* @pos: The offset (in bytes) to seek to
|
|
*
|
|
* Return: 0 on success or negative error on failure
|
|
*/
|
|
long smh_seek(long fd, long pos);
|
|
|
|
/**
|
|
* smh_getc() - Read a character from stdin
|
|
*
|
|
* Return: The character read, or a negative error on failure
|
|
*/
|
|
int smh_getc(void);
|
|
|
|
/**
|
|
* smh_putc() - Print a character on stdout
|
|
* @ch: The character to print
|
|
*/
|
|
void smh_putc(char ch);
|
|
|
|
/**
|
|
* smh_write0() - Print a nul-terminated string on stdout
|
|
* @s: The string to print
|
|
*/
|
|
void smh_puts(const char *s);
|
|
|
|
#endif /* _SEMIHOSTING_H */
|