blob: 877404a6c1385134c975004a5c54c85c7a73dbce [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/**
Heinrich Schuchardt7750ee42022-04-04 22:45:03 +020020 * os_printf() - print directly to OS console
21 *
22 * @format: format string
23 */
24int os_printf(const char *format, ...);
25
26/**
Simon Glass7a9219c2011-10-03 19:26:44 +000027 * Access to the OS read() system call
28 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010029 * @fd: File descriptor as returned by os_open()
30 * @buf: Buffer to place data
31 * @count: Number of bytes to read
32 * Return: number of bytes read, or -1 on error
Simon Glass7a9219c2011-10-03 19:26:44 +000033 */
34ssize_t os_read(int fd, void *buf, size_t count);
35
36/**
37 * Access to the OS write() system call
38 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010039 * @fd: File descriptor as returned by os_open()
40 * @buf: Buffer containing data to write
41 * @count: Number of bytes to write
42 * Return: number of bytes written, or -1 on error
Simon Glass7a9219c2011-10-03 19:26:44 +000043 */
44ssize_t os_write(int fd, const void *buf, size_t count);
45
46/**
Mike Frysingere2dcefc2011-10-25 13:02:58 +020047 * Access to the OS lseek() system call
48 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010049 * @fd: File descriptor as returned by os_open()
50 * @offset: File offset (based on whence)
51 * @whence: Position offset is relative to (see below)
52 * Return: new file offset
Mike Frysingere2dcefc2011-10-25 13:02:58 +020053 */
54off_t os_lseek(int fd, off_t offset, int whence);
55
56/* Defines for "whence" in os_lseek() */
57#define OS_SEEK_SET 0
58#define OS_SEEK_CUR 1
59#define OS_SEEK_END 2
60
61/**
Simon Glassb4467fa2021-08-18 21:40:30 -060062 * os_filesize() - Calculate the size of a file
63 *
64 * @fd: File descriptor as returned by os_open()
65 * Return: file size or negative error code
66 */
Heinrich Schuchardt1a07d392023-04-05 11:34:15 +020067off_t os_filesize(int fd);
Simon Glassb4467fa2021-08-18 21:40:30 -060068
69/**
Simon Glass7a9219c2011-10-03 19:26:44 +000070 * Access to the OS open() system call
71 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010072 * @pathname: Pathname of file to open
73 * @flags: Flags, like OS_O_RDONLY, OS_O_RDWR
74 * Return: file descriptor, or -1 on error
Simon Glass7a9219c2011-10-03 19:26:44 +000075 */
76int os_open(const char *pathname, int flags);
77
Simon Glassd9165152012-02-20 23:56:58 -050078#define OS_O_RDONLY 0
79#define OS_O_WRONLY 1
80#define OS_O_RDWR 2
81#define OS_O_MASK 3 /* Mask for read/write flags */
82#define OS_O_CREAT 0100
Simon Glass50b288a2018-10-01 11:55:07 -060083#define OS_O_TRUNC 01000
Simon Glassd9165152012-02-20 23:56:58 -050084
Simon Glass7a9219c2011-10-03 19:26:44 +000085/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010086 * os_close() - access to the OS close() system call
Simon Glass7a9219c2011-10-03 19:26:44 +000087 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010088 * @fd: File descriptor to close
89 * Return: 0 on success, -1 on error
Simon Glass7a9219c2011-10-03 19:26:44 +000090 */
91int os_close(int fd);
92
93/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010094 * os_unlink() - access to the OS unlink() system call
Stephen Warrencfd13e82014-03-01 22:18:00 -070095 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +010096 * @pathname: Path of file to delete
97 * Return: 0 for success, other for error
Stephen Warrencfd13e82014-03-01 22:18:00 -070098 */
99int os_unlink(const char *pathname);
100
Simon Glasse2d22f72023-08-24 13:55:37 -0600101/** os_persistent_fname() - Find the path to a test file
102 *
103 * @buf: Buffer to hold path
104 * @maxsize: Maximum size of buffer
105 * @fname: Leaf filename to find
106 * Returns: 0 on success, -ENOENT if file is not found, -ENOSPC if the buffer is
107 * too small
108 */
109int os_persistent_file(char *buf, int maxsize, const char *fname);
110
Stephen Warrencfd13e82014-03-01 22:18:00 -0700111/**
Sean Anderson9181cb02023-11-04 16:37:51 -0400112 * os_mktemp() - Create a temporary file
113 * @fname: The template to use for the file name. This must end with 6 Xs. It
114 * will be modified to the opened filename on success.
115 * @size: The size of the file
116 *
117 * Create a temporary file using @fname as a template, unlink it, and truncate
118 * it to @size.
119 *
120 * Return: A file descriptor, or negative errno on error
121 */
122int os_mktemp(char *fname, off_t size);
123
124/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100125 * os_exit() - access to the OS exit() system call
Simon Glass7a9219c2011-10-03 19:26:44 +0000126 *
127 * This exits with the supplied return code, which should be 0 to indicate
128 * success.
129 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100130 * @exit_code: exit code for U-Boot
Simon Glass7a9219c2011-10-03 19:26:44 +0000131 */
Mike Frysinger9d72e672012-02-26 17:46:30 -0500132void os_exit(int exit_code) __attribute__((noreturn));
Mike Frysingerab06a752011-10-26 00:21:29 +0000133
134/**
Rasmus Villemoes10107ef2022-09-27 11:54:04 +0200135 * os_alarm() - access to the OS alarm() system call
Simon Glass6ca4d5b2022-10-29 19:47:04 -0600136 *
137 * @seconds: number of seconds before the signal is sent
138 * Returns: number of seconds remaining until any previously scheduled alarm was
139 * due to be delivered; 0 if there was no previously scheduled alarm
Rasmus Villemoes10107ef2022-09-27 11:54:04 +0200140 */
141unsigned int os_alarm(unsigned int seconds);
142
143/**
144 * os_set_alarm_handler() - set handler for SIGALRM
145 *
146 * @handler: The handler function. Pass NULL for SIG_DFL.
147 */
148void os_set_alarm_handler(void (*handler)(int));
149
150/**
151 * os_raise_sigalrm() - do raise(SIGALRM)
152 */
153void os_raise_sigalrm(void);
154
155/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100156 * os_tty_raw() - put tty into raw mode to mimic serial console better
Simon Glassffb87902014-02-27 13:26:22 -0700157 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100158 * @fd: File descriptor of stdin (normally 0)
159 * @allow_sigs: Allow Ctrl-C, Ctrl-Z to generate signals rather than
160 * be handled by U-Boot
Mike Frysingerab06a752011-10-26 00:21:29 +0000161 */
Simon Glassffb87902014-02-27 13:26:22 -0700162void os_tty_raw(int fd, bool allow_sigs);
Matthias Weisser21899b12011-11-05 11:40:34 +0100163
164/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100165 * os_fs_restore() - restore the tty to its original mode
Simon Glass8939df02015-05-10 21:07:27 -0600166 *
167 * Call this to restore the original terminal mode, after it has been changed
168 * by os_tty_raw(). This is an internal function.
169 */
170void os_fd_restore(void);
171
172/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100173 * os_malloc() - aquires some memory from the underlying os.
Matthias Weisser21899b12011-11-05 11:40:34 +0100174 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100175 * @length: Number of bytes to be allocated
Simon Glass14e46df2021-02-06 09:57:32 -0700176 * Return: Pointer to length bytes or NULL if @length is 0 or on error
Matthias Weisser21899b12011-11-05 11:40:34 +0100177 */
178void *os_malloc(size_t length);
Matthias Weisserd99a6872011-11-29 12:16:40 +0100179
180/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100181 * os_free() - free memory previous allocated with os_malloc()
Simon Glass77595c62013-11-10 10:26:57 -0700182 *
183 * This returns the memory to the OS.
184 *
Simon Glassb308d9f2021-02-06 09:57:33 -0700185 * @ptr: Pointer to memory block to free. If this is NULL then this
186 * function does nothing
Simon Glass77595c62013-11-10 10:26:57 -0700187 */
Masahiro Yamada347d06d2014-01-15 13:06:41 +0900188void os_free(void *ptr);
Simon Glass77595c62013-11-10 10:26:57 -0700189
190/**
Simon Glass14e46df2021-02-06 09:57:32 -0700191 * os_realloc() - reallocate memory
192 *
193 * This follows the semantics of realloc(), so can perform an os_malloc() or
194 * os_free() depending on @ptr and @length.
195 *
Heinrich Schuchardt4c30d182021-03-28 11:05:00 +0200196 * @ptr: pointer to previously allocated memory of NULL
197 * @length: number of bytes to allocate
198 * Return: pointer to reallocated memory or NULL if @length is 0
Simon Glass14e46df2021-02-06 09:57:32 -0700199 */
200void *os_realloc(void *ptr, size_t length);
201
202/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100203 * os_usleep() - access to the usleep function of the os
Matthias Weisserd99a6872011-11-29 12:16:40 +0100204 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100205 * @usec: time to sleep in micro seconds
Matthias Weisserd99a6872011-11-29 12:16:40 +0100206 */
207void os_usleep(unsigned long usec);
208
209/**
210 * Gets a monotonic increasing number of nano seconds from the OS
211 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100212 * Return: a monotonic increasing time scaled in nano seconds
Matthias Weisserd99a6872011-11-29 12:16:40 +0100213 */
Simon Glass2a54d152013-05-19 16:45:35 -0700214uint64_t os_get_nsec(void);
Mike Frysinger4f345d52012-01-19 22:57:29 -0500215
Simon Glass70db4212012-02-15 15:51:16 -0800216/**
217 * Parse arguments and update sandbox state.
218 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100219 * @state: sandbox state to update
220 * @argc: argument count
221 * @argv: argument vector
222 * Return:
223 * * 0 if ok, and program should continue
224 * * 1 if ok, but program should stop
225 * * -1 on error: program should terminate
Simon Glass70db4212012-02-15 15:51:16 -0800226 */
227int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
228
Simon Glass62584db2012-12-26 09:53:34 +0000229/*
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100230 * enum os_dirent_t - type of directory entry
231 *
Simon Glass62584db2012-12-26 09:53:34 +0000232 * Types of directory entry that we support. See also os_dirent_typename in
233 * the C file.
234 */
235enum os_dirent_t {
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100236 /**
237 * @OS_FILET_REG: regular file
238 */
239 OS_FILET_REG,
240 /**
241 * @OS_FILET_LNK: symbolic link
242 */
243 OS_FILET_LNK,
244 /**
245 * @OS_FILET_DIR: directory
246 */
247 OS_FILET_DIR,
248 /**
249 * @OS_FILET_UNKNOWN: something else
250 */
251 OS_FILET_UNKNOWN,
252 /**
253 * @OS_FILET_COUNT: number of directory entry types
254 */
Simon Glass62584db2012-12-26 09:53:34 +0000255 OS_FILET_COUNT,
256};
257
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100258/**
259 * struct os_dirent_node - directory node
260 *
261 * A directory entry node, containing information about a single dirent
262 *
263 */
Simon Glass62584db2012-12-26 09:53:34 +0000264struct os_dirent_node {
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100265 /**
266 * @next: pointer to next node, or NULL
267 */
268 struct os_dirent_node *next;
269 /**
270 * @size: size of file in bytes
271 */
272 ulong size;
273 /**
274 * @type: type of entry
275 */
276 enum os_dirent_t type;
277 /**
278 * @name: name of entry
279 */
280 char name[0];
Simon Glass62584db2012-12-26 09:53:34 +0000281};
282
283/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100284 * os_dirent_ls() - get a directory listing
Simon Glass62584db2012-12-26 09:53:34 +0000285 *
286 * This allocates and returns a linked list containing the directory listing.
287 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100288 * @dirname: directory to examine
289 * @headp: on return pointer to head of linked list, or NULL if none
290 * Return: 0 if ok, -ve on error
Simon Glass62584db2012-12-26 09:53:34 +0000291 */
292int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
293
294/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100295 * os_dirent_free() - free directory list
Stefan Brüns86167082016-10-01 20:41:38 +0200296 *
297 * This frees a linked list containing a directory listing.
298 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100299 * @node: pointer to head of linked list
Stefan Brüns86167082016-10-01 20:41:38 +0200300 */
301void os_dirent_free(struct os_dirent_node *node);
302
303/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100304 * os_dirent_get_typename() - get the name of a directory entry type
Simon Glass62584db2012-12-26 09:53:34 +0000305 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100306 * @type: type to check
307 * Return:
308 * string containing the name of that type,
309 * or "???" if none/invalid
Simon Glass62584db2012-12-26 09:53:34 +0000310 */
311const char *os_dirent_get_typename(enum os_dirent_t type);
312
313/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100314 * os_get_filesize() - get the size of a file
Simon Glass62584db2012-12-26 09:53:34 +0000315 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100316 * @fname: filename to check
317 * @size: size of file is returned if no error
318 * Return: 0 on success or -1 if an error ocurred
Simon Glass62584db2012-12-26 09:53:34 +0000319 */
Heinrich Schuchardt880dbc52022-01-11 01:50:24 +0100320int os_get_filesize(const char *fname, long long *size);
Simon Glass62584db2012-12-26 09:53:34 +0000321
Simon Glass91b136c2013-11-10 10:27:01 -0700322/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100323 * os_putc() - write a character to the controlling OS terminal
Simon Glass0b189b62017-12-04 13:48:17 -0700324 *
325 * This bypasses the U-Boot console support and writes directly to the OS
326 * stdout file descriptor.
327 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100328 * @ch: haracter to write
Simon Glass0b189b62017-12-04 13:48:17 -0700329 */
330void os_putc(int ch);
331
332/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100333 * os_puts() - write a string to the controlling OS terminal
Simon Glass0b189b62017-12-04 13:48:17 -0700334 *
335 * This bypasses the U-Boot console support and writes directly to the OS
336 * stdout file descriptor.
337 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100338 * @str: string to write (note that \n is not appended)
Simon Glass0b189b62017-12-04 13:48:17 -0700339 */
340void os_puts(const char *str);
341
342/**
Pali Rohár7df5b352022-09-05 11:31:16 +0200343 * os_flush() - flush controlling OS terminal
344 *
345 * This bypasses the U-Boot console support and flushes directly the OS
346 * stdout file descriptor.
347 */
348void os_flush(void);
349
350/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100351 * os_write_ram_buf() - write the sandbox RAM buffer to a existing file
Simon Glass5c2859c2013-11-10 10:27:03 -0700352 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100353 * @fname: filename to write memory to (simple binary format)
354 * Return: 0 if OK, -ve on error
Simon Glass5c2859c2013-11-10 10:27:03 -0700355 */
356int os_write_ram_buf(const char *fname);
357
358/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100359 * os_read_ram_buf() - read the sandbox RAM buffer from an existing file
Simon Glass5c2859c2013-11-10 10:27:03 -0700360 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100361 * @fname: filename containing memory (simple binary format)
362 * Return: 0 if OK, -ve on error
Simon Glass5c2859c2013-11-10 10:27:03 -0700363 */
364int os_read_ram_buf(const char *fname);
365
Simon Glass47f5fcf2014-02-27 13:26:15 -0700366/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100367 * os_jump_to_image() - jump to a new executable image
Simon Glass47f5fcf2014-02-27 13:26:15 -0700368 *
369 * This uses exec() to run a new executable image, after putting it in a
370 * temporary file. The same arguments and environment are passed to this
371 * new image, with the addition of:
372 *
373 * -j <filename> Specifies the filename the image was written to. The
374 * calling image may want to delete this at some point.
375 * -m <filename> Specifies the file containing the sandbox memory
376 * (ram_buf) from this image, so that the new image can
377 * have access to this. It also means that the original
378 * memory filename passed to U-Boot will be left intact.
379 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100380 * @dest: buffer containing executable image
381 * @size: size of buffer
382 * Return: 0 if OK, -ve on error
Simon Glass47f5fcf2014-02-27 13:26:15 -0700383 */
384int os_jump_to_image(const void *dest, int size);
385
Simon Glass94eefde2015-04-20 12:37:22 -0600386/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100387 * os_find_u_boot() - determine the path to U-Boot proper
Simon Glassd4e33f52016-07-04 11:57:45 -0600388 *
389 * This function is intended to be called from within sandbox SPL. It uses
390 * a few heuristics to find U-Boot proper. Normally it is either in the same
391 * directory, or the directory above (since u-boot-spl is normally in an
392 * spl/ subdirectory when built).
393 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100394 * @fname: place to put full path to U-Boot
395 * @maxlen: maximum size of @fname
Simon Glass01ad9f72021-03-07 17:35:13 -0700396 * @use_img: select the 'u-boot.img' file instead of the 'u-boot' ELF file
Simon Glassf178beb2021-07-05 16:32:45 -0600397 * @cur_prefix: prefix of current executable, e.g. "spl" or "tpl"
398 * @next_prefix: prefix of executable to find, e.g. "spl" or ""
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100399 * Return: 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found
Simon Glassd4e33f52016-07-04 11:57:45 -0600400 */
Simon Glassf178beb2021-07-05 16:32:45 -0600401int os_find_u_boot(char *fname, int maxlen, bool use_img,
402 const char *cur_prefix, const char *next_prefix);
Simon Glassd4e33f52016-07-04 11:57:45 -0600403
404/**
405 * os_spl_to_uboot() - Run U-Boot proper
406 *
407 * When called from SPL, this runs U-Boot proper. The filename is obtained by
408 * calling os_find_u_boot().
409 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100410 * @fname: full pathname to U-Boot executable
411 * Return: 0 if OK, -ve on error
Simon Glassd4e33f52016-07-04 11:57:45 -0600412 */
413int os_spl_to_uboot(const char *fname);
414
415/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100416 * os_localtime() - read the current system time
Simon Glass94eefde2015-04-20 12:37:22 -0600417 *
418 * This reads the current Local Time and places it into the provided
419 * structure.
420 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100421 * @rt: place to put system time
Simon Glass94eefde2015-04-20 12:37:22 -0600422 */
423void os_localtime(struct rtc_time *rt);
424
Simon Glass30eef212018-05-16 09:42:22 -0600425/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100426 * os_abort() - raise SIGABRT to exit sandbox (e.g. to debugger)
Simon Glassfe938fb2018-09-15 00:50:55 -0600427 */
Heinrich Schuchardtc30a7092021-02-01 01:24:10 +0100428void os_abort(void) __attribute__((noreturn));
Simon Glass9f8037e2018-10-01 21:12:32 -0600429
430/**
431 * os_mprotect_allow() - Remove write-protection on a region of memory
432 *
433 * The start and length will be page-aligned before use.
434 *
435 * @start: Region start
436 * @len: Region length in bytes
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100437 * Return: 0 if OK, -1 on error from mprotect()
Simon Glass9f8037e2018-10-01 21:12:32 -0600438 */
439int os_mprotect_allow(void *start, size_t len);
440
Simon Glass056a5ce2018-10-01 11:55:08 -0600441/**
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100442 * os_write_file() - write a file to the host filesystem
Simon Glass056a5ce2018-10-01 11:55:08 -0600443 *
444 * This can be useful when debugging for writing data out of sandbox for
445 * inspection by external tools.
446 *
447 * @name: File path to write to
448 * @buf: Data to write
449 * @size: Size of data to write
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100450 * Return: 0 if OK, -ve on error
Simon Glass056a5ce2018-10-01 11:55:08 -0600451 */
452int os_write_file(const char *name, const void *buf, int size);
453
Simon Glass566bf3a2018-11-06 15:21:25 -0700454/**
455 * os_read_file() - Read a file from the host filesystem
456 *
457 * This can be useful when reading test data into sandbox for use by test
458 * routines. The data is allocated using os_malloc() and should be freed by
459 * the caller.
460 *
461 * @name: File path to read from
462 * @bufp: Returns buffer containing data read
463 * @sizep: Returns size of data
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100464 * Return: 0 if OK, -ve on error
Simon Glass566bf3a2018-11-06 15:21:25 -0700465 */
466int os_read_file(const char *name, void **bufp, int *sizep);
467
Simon Glassb9274092021-08-18 21:40:31 -0600468/**
469 * os_map_file() - Map a file from the host filesystem into memory
470 *
471 * This can be useful when to provide a backing store for an emulated device
472 *
473 * @pathname: File pathname to map
474 * @os_flags: Flags, like OS_O_RDONLY, OS_O_RDWR
475 * @bufp: Returns buffer containing the file
476 * @sizep: Returns size of data
477 * Return: 0 if OK, -ve on error
478 */
479int os_map_file(const char *pathname, int os_flags, void **bufp, int *sizep);
480
Simon Glassa0ff2802021-10-23 17:25:58 -0600481/**
482 * os_unmap() - Unmap a file previously mapped
483 *
484 * @buf: Mapped address
485 * @size: Size in bytes
486 * Return: 0 if OK, -ve on error
487 */
488int os_unmap(void *buf, int size);
489
Simon Glass001d1882019-04-08 13:20:41 -0600490/*
491 * os_find_text_base() - Find the text section in this running process
492 *
493 * This tries to find the address of the text section in this running process.
494 * It can be useful to map the address of functions to the address listed in
495 * the u-boot.map file.
496 *
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100497 * Return: address if found, else NULL
Simon Glass001d1882019-04-08 13:20:41 -0600498 */
499void *os_find_text_base(void);
500
Heinrich Schuchardt329dccc2020-10-27 20:29:25 +0100501/**
502 * os_relaunch() - restart the sandbox
503 *
504 * This functions is used to implement the cold reboot of the sand box.
Heinrich Schuchardt063790c2020-10-27 20:29:27 +0100505 * @argv\[0] specifies the binary that is started while the calling process
Heinrich Schuchardt329dccc2020-10-27 20:29:25 +0100506 * stops immediately. If the new binary cannot be started, the process is
507 * terminated and 1 is set as shell return code.
508 *
509 * The PID of the process stays the same. All file descriptors that have not
510 * been opened with O_CLOEXEC stay open including stdin, stdout, stderr.
511 *
512 * @argv: NULL terminated list of command line parameters
513 */
514void os_relaunch(char *argv[]);
515
Heinrich Schuchardtb46f30a2020-11-12 00:29:56 +0100516/**
517 * os_setup_signal_handlers() - setup signal handlers
518 *
519 * Install signal handlers for SIGBUS and SIGSEGV.
520 *
521 * Return: 0 for success
522 */
523int os_setup_signal_handlers(void);
524
525/**
526 * os_signal_action() - handle a signal
527 *
528 * @sig: signal
529 * @pc: program counter
530 */
531void os_signal_action(int sig, unsigned long pc);
532
Heinrich Schuchardt43db0752020-12-30 18:07:48 +0100533/**
534 * os_get_time_offset() - get time offset
535 *
536 * Get the time offset from environment variable UBOOT_SB_TIME_OFFSET.
537 *
538 * Return: offset in seconds
539 */
540long os_get_time_offset(void);
541
542/**
543 * os_set_time_offset() - set time offset
544 *
545 * Save the time offset in environment variable UBOOT_SB_TIME_OFFSET.
546 *
547 * @offset: offset in seconds
548 */
549void os_set_time_offset(long offset);
550
Mike Frysinger4f345d52012-01-19 22:57:29 -0500551#endif