1 /*
2  * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 #pragma once
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  * @brief ESP32-S3 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. There are two pointers, `syscall_table_ptr_pro` and
27  * `syscall_table_ptr_app`, which can be set to point to the locations of syscall tables of CPU 0 (aka PRO CPU)
28  * and CPU 1 (aka APP CPU). Location of these pointers in .bss segment of ROM code is defined in linker script.
29  *
30  * So, before using any of the C library functions (except for pure functions and memcpy/memset functions),
31  * application must allocate syscall table structure for each CPU being used, and populate it with pointers
32  * to actual implementations of corresponding syscalls.
33  *
34  */
35 struct syscall_stub_table
36 {
37     struct _reent* (*__getreent)(void);
38     void* (*_malloc_r)(struct _reent *r, size_t);
39     void (*_free_r)(struct _reent *r, void*);
40     void* (*_realloc_r)(struct _reent *r, void*, size_t);
41     void* (*_calloc_r)(struct _reent *r, size_t, size_t);
42     void (*_abort)(void);
43     int (*_system_r)(struct _reent *r, const char*);
44     int (*_rename_r)(struct _reent *r, const char*, const char*);
45     clock_t (*_times_r)(struct _reent *r, struct tms *);
46     int (*_gettimeofday_r) (struct _reent *r, struct timeval *, void *);
47     void (*_raise_r)(struct _reent *r);
48     int (*_unlink_r)(struct _reent *r, const char*);
49     int (*_link_r)(struct _reent *r, const char*, const char*);
50     int (*_stat_r)(struct _reent *r, const char*, struct stat *);
51     int (*_fstat_r)(struct _reent *r, int, struct stat *);
52     void* (*_sbrk_r)(struct _reent *r, ptrdiff_t);
53     int (*_getpid_r)(struct _reent *r);
54     int (*_kill_r)(struct _reent *r, int, int);
55     void (*_exit_r)(struct _reent *r, int);
56     int (*_close_r)(struct _reent *r, int);
57     int (*_open_r)(struct _reent *r, const char *, int, int);
58     int (*_write_r)(struct _reent *r, int, const void *, int);
59     int (*_lseek_r)(struct _reent *r, int, int, int);
60     int (*_read_r)(struct _reent *r, int, void *, int);
61     void (*_retarget_lock_init)(_LOCK_T *lock);
62     void (*_retarget_lock_init_recursive)(_LOCK_T *lock);
63     void (*_retarget_lock_close)(_LOCK_T lock);
64     void (*_retarget_lock_close_recursive)(_LOCK_T lock);
65     void (*_retarget_lock_acquire)(_LOCK_T lock);
66     void (*_retarget_lock_acquire_recursive)(_LOCK_T lock);
67     int (*_retarget_lock_try_acquire)(_LOCK_T lock);
68     int (*_retarget_lock_try_acquire_recursive)(_LOCK_T lock);
69     void (*_retarget_lock_release)(_LOCK_T lock);
70     void (*_retarget_lock_release_recursive)(_LOCK_T lock);
71     int (*_printf_float)(struct _reent *data, void *pdata, FILE * fp, int (*pfunc) (struct _reent *, FILE *, const char *, size_t len), va_list * ap);
72     int (*_scanf_float) (struct _reent *rptr, void *pdata, FILE *fp, va_list *ap);
73     void (*__assert_func) (const char *file, int line, const char * func, const char *failedexpr) __attribute__((__noreturn__));
74     void (*__sinit) (struct _reent *r);
75     void (*_cleanup_r) (struct _reent* r);
76 };
77 
78 extern struct syscall_stub_table *syscall_table_ptr;
79 #define syscall_table_ptr_pro syscall_table_ptr
80 #define syscall_table_ptr_app syscall_table_ptr
81 
82 #ifdef __cplusplus
83 } // extern "C"
84 #endif
85