1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/* 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 */
|
