blob: c8e0f52d306345ac91d2a57d3dffe913e98e3764 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass7a9219c2011-10-03 19:26:44 +00002/*
Simon Glassd9165152012-02-20 23:56:58 -05003 * Operating System Interface
4 *
5 * This provides access to useful OS routines for the sandbox architecture.
6 * They are kept in a separate file so we can include system headers.
7 *
Simon Glass7a9219c2011-10-03 19:26:44 +00008 * Copyright (c) 2011 The Chromium OS Authors.
Simon Glass7a9219c2011-10-03 19:26:44 +00009 */
10
Mike Frysinger4f345d52012-01-19 22:57:29 -050011#ifndef __OS_H__
12#define __OS_H__
13
Simon Glass2a54d152013-05-19 16:45:35 -070014#include <linux/types.h>
15
Simon Glass94eefde2015-04-20 12:37:22 -060016struct rtc_time;
Simon Glass70db4212012-02-15 15:51:16 -080017struct sandbox_state;
18
Simon Glass7a9219c2011-10-03 19:26:44 +000019/**
20 * Access to the OS read() system call
21 *
22 * \param fd File descriptor as returned by os_open()
23 * \param buf Buffer to place data
24 * \param count Number of bytes to read
25 * \return number of bytes read, or -1 on error
26 */
27ssize_t os_read(int fd, void *buf, size_t count);
28
29/**
Taylor Hutte1015502013-02-24 17:33:13 +000030 * Access to the OS read() system call with non-blocking access
31 *
32 * \param fd File descriptor as returned by os_open()
33 * \param buf Buffer to place data
34 * \param count Number of bytes to read
35 * \return number of bytes read, or -1 on error
36 */
37ssize_t os_read_no_block(int fd, void *buf, size_t count);
38
39/**
Simon Glass7a9219c2011-10-03 19:26:44 +000040 * Access to the OS write() system call
41 *
42 * \param fd File descriptor as returned by os_open()
43 * \param buf Buffer containing data to write
44 * \param count Number of bytes to write
45 * \return number of bytes written, or -1 on error
46 */
47ssize_t os_write(int fd, const void *buf, size_t count);
48
49/**
Mike Frysingere2dcefc2011-10-25 13:02:58 +020050 * Access to the OS lseek() system call
51 *
52 * \param fd File descriptor as returned by os_open()
53 * \param offset File offset (based on whence)
54 * \param whence Position offset is relative to (see below)
55 * \return new file offset
56 */
57off_t os_lseek(int fd, off_t offset, int whence);
58
59/* Defines for "whence" in os_lseek() */
60#define OS_SEEK_SET 0
61#define OS_SEEK_CUR 1
62#define OS_SEEK_END 2
63
64/**
Simon Glass7a9219c2011-10-03 19:26:44 +000065 * Access to the OS open() system call
66 *
67 * \param pathname Pathname of file to open
Simon Glass887bd412015-03-25 12:21:50 -060068 * \param flags Flags, like OS_O_RDONLY, OS_O_RDWR
Simon Glass7a9219c2011-10-03 19:26:44 +000069 * \return file descriptor, or -1 on error
70 */
71int os_open(const char *pathname, int flags);
72
Simon Glassd9165152012-02-20 23:56:58 -050073#define OS_O_RDONLY 0
74#define OS_O_WRONLY 1
75#define OS_O_RDWR 2
76#define OS_O_MASK 3 /* Mask for read/write flags */
77#define OS_O_CREAT 0100
78
Simon Glass7a9219c2011-10-03 19:26:44 +000079/**
80 * Access to the OS close() system call
81 *
82 * \param fd File descriptor to close
83 * \return 0 on success, -1 on error
84 */
85int os_close(int fd);
86
87/**
Stephen Warrencfd13e82014-03-01 22:18:00 -070088 * Access to the OS unlink() system call
89 *
90 * \param pathname Path of file to delete
91 * \return 0 for success, other for error
92 */
93int os_unlink(const char *pathname);
94
95/**
Simon Glass7a9219c2011-10-03 19:26:44 +000096 * Access to the OS exit() system call
97 *
98 * This exits with the supplied return code, which should be 0 to indicate
99 * success.
100 *
101 * @param exit_code exit code for U-Boot
102 */
Mike Frysinger9d72e672012-02-26 17:46:30 -0500103void os_exit(int exit_code) __attribute__((noreturn));
Mike Frysingerab06a752011-10-26 00:21:29 +0000104
105/**
106 * Put tty into raw mode to mimic serial console better
Simon Glassffb87902014-02-27 13:26:22 -0700107 *
108 * @param fd File descriptor of stdin (normally 0)
109 * @param allow_sigs Allow Ctrl-C, Ctrl-Z to generate signals rather than
110 * be handled by U-Boot
Mike Frysingerab06a752011-10-26 00:21:29 +0000111 */
Simon Glassffb87902014-02-27 13:26:22 -0700112void os_tty_raw(int fd, bool allow_sigs);
Matthias Weisser21899b12011-11-05 11:40:34 +0100113
114/**
Simon Glass8939df02015-05-10 21:07:27 -0600115 * Restore the tty to its original mode
116 *
117 * Call this to restore the original terminal mode, after it has been changed
118 * by os_tty_raw(). This is an internal function.
119 */
120void os_fd_restore(void);
121
122/**
Matthias Weisser21899b12011-11-05 11:40:34 +0100123 * Acquires some memory from the underlying os.
124 *
125 * \param length Number of bytes to be allocated
126 * \return Pointer to length bytes or NULL on error
127 */
128void *os_malloc(size_t length);
Matthias Weisserd99a6872011-11-29 12:16:40 +0100129
130/**
Simon Glass77595c62013-11-10 10:26:57 -0700131 * Free memory previous allocated with os_malloc()/os_realloc()
132 *
133 * This returns the memory to the OS.
134 *
135 * \param ptr Pointer to memory block to free
136 */
Masahiro Yamada347d06d2014-01-15 13:06:41 +0900137void os_free(void *ptr);
Simon Glass77595c62013-11-10 10:26:57 -0700138
139/**
140 * Reallocate previously-allocated memory to increase/decrease space
141 *
142 * This works in a similar way to the C library realloc() function. If
143 * length is 0, then ptr is freed. Otherwise the space used by ptr is
144 * expanded or reduced depending on whether length is larger or smaller
145 * than before.
146 *
147 * If ptr is NULL, then this is similar to calling os_malloc().
148 *
149 * This function may need to move the memory block to make room for any
150 * extra space, in which case the new pointer is returned.
151 *
152 * \param ptr Pointer to memory block to reallocate
153 * \param length New length for memory block
154 * \return pointer to new memory block, or NULL on failure or if length
155 * is 0.
156 */
157void *os_realloc(void *ptr, size_t length);
158
159/**
Matthias Weisserd99a6872011-11-29 12:16:40 +0100160 * Access to the usleep function of the os
161 *
162 * \param usec Time to sleep in micro seconds
163 */
164void os_usleep(unsigned long usec);
165
166/**
167 * Gets a monotonic increasing number of nano seconds from the OS
168 *
169 * \return A monotonic increasing time scaled in nano seconds
170 */
Simon Glass2a54d152013-05-19 16:45:35 -0700171uint64_t os_get_nsec(void);
Mike Frysinger4f345d52012-01-19 22:57:29 -0500172
Simon Glass70db4212012-02-15 15:51:16 -0800173/**
174 * Parse arguments and update sandbox state.
175 *
176 * @param state Sandbox state to update
177 * @param argc Argument count
178 * @param argv Argument vector
179 * @return 0 if ok, and program should continue;
180 * 1 if ok, but program should stop;
181 * -1 on error: program should terminate.
182 */
183int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
184
Simon Glass62584db2012-12-26 09:53:34 +0000185/*
186 * Types of directory entry that we support. See also os_dirent_typename in
187 * the C file.
188 */
189enum os_dirent_t {
190 OS_FILET_REG, /* Regular file */
191 OS_FILET_LNK, /* Symbolic link */
192 OS_FILET_DIR, /* Directory */
193 OS_FILET_UNKNOWN, /* Something else */
194
195 OS_FILET_COUNT,
196};
197
198/** A directory entry node, containing information about a single dirent */
199struct os_dirent_node {
200 struct os_dirent_node *next; /* Pointer to next node, or NULL */
201 ulong size; /* Size of file in bytes */
202 enum os_dirent_t type; /* Type of entry */
203 char name[0]; /* Name of entry */
204};
205
206/**
207 * Get a directionry listing
208 *
209 * This allocates and returns a linked list containing the directory listing.
210 *
211 * @param dirname Directory to examine
212 * @param headp Returns pointer to head of linked list, or NULL if none
213 * @return 0 if ok, -ve on error
214 */
215int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
216
217/**
Stefan Brüns86167082016-10-01 20:41:38 +0200218 * Free directory list
219 *
220 * This frees a linked list containing a directory listing.
221 *
222 * @param node Pointer to head of linked list
223 */
224void os_dirent_free(struct os_dirent_node *node);
225
226/**
Simon Glass62584db2012-12-26 09:53:34 +0000227 * Get the name of a directory entry type
228 *
Stefan Brüns86167082016-10-01 20:41:38 +0200229 * @param type Type to check
Simon Glass62584db2012-12-26 09:53:34 +0000230 * @return string containing the name of that type, or "???" if none/invalid
231 */
232const char *os_dirent_get_typename(enum os_dirent_t type);
233
234/**
235 * Get the size of a file
236 *
237 * @param fname Filename to check
Suriyan Ramasami96b10462014-11-17 14:39:37 -0800238 * @param size size of file is returned if no error
239 * @return 0 on success or -1 if an error ocurred
Simon Glass62584db2012-12-26 09:53:34 +0000240 */
Suriyan Ramasami96b10462014-11-17 14:39:37 -0800241int os_get_filesize(const char *fname, loff_t *size);
Simon Glass62584db2012-12-26 09:53:34 +0000242
Simon Glass91b136c2013-11-10 10:27:01 -0700243/**
Simon Glass0b189b62017-12-04 13:48:17 -0700244 * Write a character to the controlling OS terminal
245 *
246 * This bypasses the U-Boot console support and writes directly to the OS
247 * stdout file descriptor.
248 *
249 * @param ch Character to write
250 */
251void os_putc(int ch);
252
253/**
254 * Write a string to the controlling OS terminal
255 *
256 * This bypasses the U-Boot console support and writes directly to the OS
257 * stdout file descriptor.
258 *
259 * @param str String to write (note that \n is not appended)
260 */
261void os_puts(const char *str);
262
263/**
Simon Glass5c2859c2013-11-10 10:27:03 -0700264 * Write the sandbox RAM buffer to a existing file
265 *
266 * @param fname Filename to write memory to (simple binary format)
267 * @return 0 if OK, -ve on error
268 */
269int os_write_ram_buf(const char *fname);
270
271/**
272 * Read the sandbox RAM buffer from an existing file
273 *
274 * @param fname Filename containing memory (simple binary format)
275 * @return 0 if OK, -ve on error
276 */
277int os_read_ram_buf(const char *fname);
278
Simon Glass47f5fcf2014-02-27 13:26:15 -0700279/**
280 * Jump to a new executable image
281 *
282 * This uses exec() to run a new executable image, after putting it in a
283 * temporary file. The same arguments and environment are passed to this
284 * new image, with the addition of:
285 *
286 * -j <filename> Specifies the filename the image was written to. The
287 * calling image may want to delete this at some point.
288 * -m <filename> Specifies the file containing the sandbox memory
289 * (ram_buf) from this image, so that the new image can
290 * have access to this. It also means that the original
291 * memory filename passed to U-Boot will be left intact.
292 *
293 * @param dest Buffer containing executable image
294 * @param size Size of buffer
295 */
296int os_jump_to_image(const void *dest, int size);
297
Simon Glass94eefde2015-04-20 12:37:22 -0600298/**
Simon Glassd4e33f52016-07-04 11:57:45 -0600299 * os_find_u_boot() - Determine the path to U-Boot proper
300 *
301 * This function is intended to be called from within sandbox SPL. It uses
302 * a few heuristics to find U-Boot proper. Normally it is either in the same
303 * directory, or the directory above (since u-boot-spl is normally in an
304 * spl/ subdirectory when built).
305 *
306 * @fname: Place to put full path to U-Boot
307 * @maxlen: Maximum size of @fname
308 * @return 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found
309 */
310int os_find_u_boot(char *fname, int maxlen);
311
312/**
313 * os_spl_to_uboot() - Run U-Boot proper
314 *
315 * When called from SPL, this runs U-Boot proper. The filename is obtained by
316 * calling os_find_u_boot().
317 *
318 * @fname: Full pathname to U-Boot executable
319 * @return 0 if OK, -ve on error
320 */
321int os_spl_to_uboot(const char *fname);
322
323/**
Simon Glass94eefde2015-04-20 12:37:22 -0600324 * Read the current system time
325 *
326 * This reads the current Local Time and places it into the provided
327 * structure.
328 *
329 * @param rt Place to put system time
330 */
331void os_localtime(struct rtc_time *rt);
332
Simon Glass30eef212018-05-16 09:42:22 -0600333/**
334 * os_setjmp() - Call setjmp()
335 *
336 * Call the host system's setjmp() function.
337 *
338 * @jmp: Buffer to store current execution state
339 * @size: Size of buffer
340 * @return normal setjmp() value if OK, -ENOSPC if @size is too small
341 */
342int os_setjmp(ulong *jmp, int size);
343
344/**
345 * os_longjmp() - Call longjmp()
346 *
347 * Call the host system's longjmp() function.
348 *
349 * @jmp: Buffer where previous execution state was stored
350 * @ret: Value to pass to longjmp()
351 */
352void os_longjmp(ulong *jmp, int ret);
353
Mike Frysinger4f345d52012-01-19 22:57:29 -0500354#endif