Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-11-13 00:17:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

arm: smh: Document functions in header

Browse source 
This adds some documentation for semihosting functions in the header.

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
This commit is contained in:
Sean Anderson 2022-03-22 16:59:17 -04:00 committed by Tom Rini
parent 80e62ccfa6
commit 79f6ad6a7b
2 changed files with 32 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
arch/arm/lib/semihosting.c
View file

@ -80,9 +80,6 @@ long smh_open(const char *fname, enum smh_open_mode mode)
return fd; return fd;
} }
/*
* Read 'len' bytes of file into 'memp'. Returns 0 on success, else failure
*/
long smh_read(long fd, void *memp, size_t len) long smh_read(long fd, void *memp, size_t len)
{ {
long ret; long ret;
@ -104,9 +101,6 @@ long smh_read(long fd, void *memp, size_t len)
return len - ret; return len - ret;
} }
/*
* Close the file using the file descriptor
*/
long smh_close(long fd) long smh_close(long fd)
{ {
long ret; long ret;
@ -119,9 +113,6 @@ long smh_close(long fd)
return 0; return 0;
} }
/*
* Get the file length from the file descriptor
*/
long smh_flen(long fd) long smh_flen(long fd)
{ {
long ret; long ret;

32
include/semihosting.h
View file

@ -29,9 +29,41 @@ enum smh_open_mode {
MODE_APPEND = 0x8, 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); 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); long smh_read(long fd, void *memp, size_t len);
/**
* 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); 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); long smh_flen(long fd);
#endif /* _SEMIHOSTING_H */ #endif /* _SEMIHOSTING_H */