1 /*
2  * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 #ifndef _ROM_LIBC_STUBS_H_
7 #define _ROM_LIBC_STUBS_H_
8 
9 #include <sys/lock.h>
10 #include <stddef.h>
11 #include <stdint.h>
12 #include <stdio.h>
13 #include <stdarg.h>
14 #include <reent.h>
15 #include <errno.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /*
22 ESP32-C6 ROM code contains implementations of some of C library functions.
23 Whenever a function in ROM needs to use a syscall, it calls a pointer to the corresponding syscall
24 implementation defined in the following struct.
25 
26 The table itself, by default, is not allocated in RAM. A global pointer syscall_table_ptr is used to
27 set the address
28 
29 So, before using any of the C library functions (except for pure functions and memcpy/memset functions),
30 application must allocate syscall table structure for each CPU being used, and populate it with pointers
31 to actual implementations of corresponding syscalls.
32 */
33 
34 struct syscall_stub_table {
35     struct _reent *(*__getreent)(void);
36     void *(*_malloc_r)(struct _reent *r, size_t);
37     void (*_free_r)(struct _reent *r, void *);
38     void *(*_realloc_r)(struct _reent *r, void *, size_t);
39     void *(*_calloc_r)(struct _reent *r, size_t, size_t);
40     void (*_abort)(void);
41     int (*_system_r)(struct _reent *r, const char *);
42     int (*_rename_r)(struct _reent *r, const char *, const char *);
43     clock_t (*_times_r)(struct _reent *r, struct tms *);
44     int (*_gettimeofday_r) (struct _reent *r, struct timeval *, void *);
45     void (*_raise_r)(struct _reent *r);
46     int (*_unlink_r)(struct _reent *r, const char *);
47     int (*_link_r)(struct _reent *r, const char *, const char *);
48     int (*_stat_r)(struct _reent *r, const char *, struct stat *);
49     int (*_fstat_r)(struct _reent *r, int, struct stat *);
50     void *(*_sbrk_r)(struct _reent *r, ptrdiff_t);
51     int (*_getpid_r)(struct _reent *r);
52     int (*_kill_r)(struct _reent *r, int, int);
53     void (*_exit_r)(struct _reent *r, int);
54     int (*_close_r)(struct _reent *r, int);
55     int (*_open_r)(struct _reent *r, const char *, int, int);
56     int (*_write_r)(struct _reent *r, int, const void *, int);
57     int (*_lseek_r)(struct _reent *r, int, int, int);
58     int (*_read_r)(struct _reent *r, int, void *, int);
59     void (*_retarget_lock_init)(_LOCK_T *lock);
60     void (*_retarget_lock_init_recursive)(_LOCK_T *lock);
61     void (*_retarget_lock_close)(_LOCK_T lock);
62     void (*_retarget_lock_close_recursive)(_LOCK_T lock);
63     void (*_retarget_lock_acquire)(_LOCK_T lock);
64     void (*_retarget_lock_acquire_recursive)(_LOCK_T lock);
65     int (*_retarget_lock_try_acquire)(_LOCK_T lock);
66     int (*_retarget_lock_try_acquire_recursive)(_LOCK_T lock);
67     void (*_retarget_lock_release)(_LOCK_T lock);
68     void (*_retarget_lock_release_recursive)(_LOCK_T lock);
69     int (*_printf_float)(struct _reent *data, void *pdata, FILE *fp, int (*pfunc) (struct _reent *, FILE *, const char *, size_t len), va_list *ap);
70     int (*_scanf_float) (struct _reent *rptr, void *pdata, FILE *fp, va_list *ap);
71     void (*__assert_func) (const char *file, int line, const char *func, const char *failedexpr) __attribute__((__noreturn__));
72     void (*__sinit) (struct _reent *r);
73     void (*_cleanup_r) (struct _reent *r);
74 };
75 
76 extern struct syscall_stub_table *syscall_table_ptr;
77 
78 #ifdef __cplusplus
79 } // extern "C"
80 #endif
81 
82 #endif /* _ROM_LIBC_STUBS_H_ */
83