Zephyr API Documentation  3.6.0
A Scalable Open Source RTOS
3.6.0
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
syscall.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
16#ifndef ZEPHYR_INCLUDE_ARCH_XTENSA_SYSCALL_H_
17#define ZEPHYR_INCLUDE_ARCH_XTENSA_SYSCALL_H_
18
19#ifdef CONFIG_USERSPACE
20#ifndef _ASMLANGUAGE
21
22#include <zephyr/types.h>
23#include <stdbool.h>
24#include <zephyr/linker/sections.h>
25#include <zephyr/sys/util_macro.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
32uintptr_t xtensa_syscall_helper(uintptr_t arg1, uintptr_t arg2,
33 uintptr_t arg3, uintptr_t arg4,
34 uintptr_t arg5, uintptr_t arg6,
35 uintptr_t call_id);
36
37#define SYSINL ALWAYS_INLINE
38#else
39#define SYSINL inline
40#endif /* CONFIG_XTENSA_SYSCALL_USE_HELPER */
41
51static SYSINL uintptr_t arch_syscall_invoke6(uintptr_t arg1, uintptr_t arg2,
52 uintptr_t arg3, uintptr_t arg4,
53 uintptr_t arg5, uintptr_t arg6,
54 uintptr_t call_id)
55{
56#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
57 return xtensa_syscall_helper(arg1, arg2, arg3, arg4, arg5, arg6, call_id);
58#else
59 register uintptr_t a2 __asm__("%a2") = call_id;
60 register uintptr_t a6 __asm__("%a6") = arg1;
61 register uintptr_t a3 __asm__("%a3") = arg2;
62 register uintptr_t a4 __asm__("%a4") = arg3;
63 register uintptr_t a5 __asm__("%a5") = arg4;
64 register uintptr_t a8 __asm__("%a8") = arg5;
65 register uintptr_t a9 __asm__("%a9") = arg6;
66
67 __asm__ volatile("syscall\n\t"
68 : "=r" (a2)
69 : "r" (a2), "r" (a6), "r" (a3), "r" (a4),
70 "r" (a5), "r" (a8), "r" (a9)
71 : "memory");
72
73 return a2;
74#endif /* CONFIG_XTENSA_SYSCALL_USE_HELPER */
75}
76
77static SYSINL uintptr_t arch_syscall_invoke5(uintptr_t arg1, uintptr_t arg2,
78 uintptr_t arg3, uintptr_t arg4,
79 uintptr_t arg5, uintptr_t call_id)
80{
81#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
82 return xtensa_syscall_helper(arg1, arg2, arg3, arg4, arg5, 0, call_id);
83#else
84 register uintptr_t a2 __asm__("%a2") = call_id;
85 register uintptr_t a6 __asm__("%a6") = arg1;
86 register uintptr_t a3 __asm__("%a3") = arg2;
87 register uintptr_t a4 __asm__("%a4") = arg3;
88 register uintptr_t a5 __asm__("%a5") = arg4;
89 register uintptr_t a8 __asm__("%a8") = arg5;
90
91 __asm__ volatile("syscall\n\t"
92 : "=r" (a2)
93 : "r" (a2), "r" (a6), "r" (a3), "r" (a4),
94 "r" (a5), "r" (a8)
95 : "memory");
96
97 return a2;
98#endif /* CONFIG_XTENSA_SYSCALL_USE_HELPER */
99}
100
101static SYSINL uintptr_t arch_syscall_invoke4(uintptr_t arg1, uintptr_t arg2,
102 uintptr_t arg3, uintptr_t arg4,
103 uintptr_t call_id)
104{
105#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
106 return xtensa_syscall_helper(arg1, arg2, arg3, arg4, 0, 0, call_id);
107#else
108 register uintptr_t a2 __asm__("%a2") = call_id;
109 register uintptr_t a6 __asm__("%a6") = arg1;
110 register uintptr_t a3 __asm__("%a3") = arg2;
111 register uintptr_t a4 __asm__("%a4") = arg3;
112 register uintptr_t a5 __asm__("%a5") = arg4;
113
114 __asm__ volatile("syscall\n\t"
115 : "=r" (a2)
116 : "r" (a2), "r" (a6), "r" (a3), "r" (a4),
117 "r" (a5)
118 : "memory");
119
120 return a2;
121#endif /* CONFIG_XTENSA_SYSCALL_USE_HELPER */
122}
123
124static SYSINL uintptr_t arch_syscall_invoke3(uintptr_t arg1, uintptr_t arg2,
125 uintptr_t arg3, uintptr_t call_id)
126{
127#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
128 return xtensa_syscall_helper(arg1, arg2, arg3, 0, 0, 0, call_id);
129#else
130 register uintptr_t a2 __asm__("%a2") = call_id;
131 register uintptr_t a6 __asm__("%a6") = arg1;
132 register uintptr_t a3 __asm__("%a3") = arg2;
133 register uintptr_t a4 __asm__("%a4") = arg3;
134
135 __asm__ volatile("syscall\n\t"
136 : "=r" (a2)
137 : "r" (a2), "r" (a6), "r" (a3), "r" (a4)
138 : "memory");
139
140 return a2;
141#endif /* CONFIG_XTENSA_SYSCALL_USE_HELPER */
142}
143
144static SYSINL uintptr_t arch_syscall_invoke2(uintptr_t arg1, uintptr_t arg2,
145 uintptr_t call_id)
146{
147#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
148 return xtensa_syscall_helper(arg1, arg2, 0, 0, 0, 0, call_id);
149#else
150 register uintptr_t a2 __asm__("%a2") = call_id;
151 register uintptr_t a6 __asm__("%a6") = arg1;
152 register uintptr_t a3 __asm__("%a3") = arg2;
153
154 __asm__ volatile("syscall\n\t"
155 : "=r" (a2)
156 : "r" (a2), "r" (a6), "r" (a3)
157 : "memory");
158
159 return a2;
160#endif
161}
162
163static SYSINL uintptr_t arch_syscall_invoke1(uintptr_t arg1,
164 uintptr_t call_id)
165{
166#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
167 return xtensa_syscall_helper(arg1, 0, 0, 0, 0, 0, call_id);
168#else
169 register uintptr_t a2 __asm__("%a2") = call_id;
170 register uintptr_t a6 __asm__("%a6") = arg1;
171
172 __asm__ volatile("syscall\n\t"
173 : "=r" (a2)
174 : "r" (a2), "r" (a6)
175 : "memory");
176
177 return a2;
178#endif
179}
180
181static SYSINL uintptr_t arch_syscall_invoke0(uintptr_t call_id)
182{
183#ifdef CONFIG_XTENSA_SYSCALL_USE_HELPER
184 return xtensa_syscall_helper(0, 0, 0, 0, 0, 0, call_id);
185#else
186 register uintptr_t a2 __asm__("%a2") = call_id;
187
188 __asm__ volatile("syscall\n\t"
189 : "=r" (a2)
190 : "r" (a2)
191 : "memory");
192
193 return a2;
194#endif
195}
196
197/*
198 * There is no easy (or generic) way to figure out if a thread is runnining
199 * in un-privileged mode. Reading the currrent ring (PS.CRING) is a privileged
200 * instruction and not thread local storage is not available in xcc.
201 */
202static inline bool arch_is_user_context(void)
203{
204 uint32_t thread;
205
206 __asm__ volatile(
207 "rur.THREADPTR %0\n\t"
208 : "=a" (thread)
209 );
210#ifdef CONFIG_THREAD_LOCAL_STORAGE
211 extern __thread uint32_t is_user_mode;
212
213 if (!thread) {
214 return false;
215 }
216
217 return is_user_mode != 0;
218#else
219 return !!thread;
220#endif
221}
222
223#undef SYSINL
224
225#ifdef __cplusplus
226}
227#endif
228
229#endif /* _ASMLANGUAGE */
230#endif /* CONFIG_USERSPACE */
231#endif /* ZEPHYR_INCLUDE_ARCH_XTENSA_SYSCALL_H_ */
arch_syscall_invoke4
static uintptr_t arch_syscall_invoke4(uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4, uintptr_t call_id)
Definition: syscall.h:89
arch_syscall_invoke2
static uintptr_t arch_syscall_invoke2(uintptr_t arg1, uintptr_t arg2, uintptr_t call_id)
Definition: syscall.h:131
arch_syscall_invoke1
static uintptr_t arch_syscall_invoke1(uintptr_t arg1, uintptr_t call_id)
Definition: syscall.h:149
arch_syscall_invoke0
static uintptr_t arch_syscall_invoke0(uintptr_t call_id)
Definition: syscall.h:165
arch_is_user_context
static bool arch_is_user_context(void)
Definition: syscall.h:181
arch_syscall_invoke5
static uintptr_t arch_syscall_invoke5(uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4, uintptr_t arg5, uintptr_t call_id)
Definition: syscall.h:65
arch_syscall_invoke3
static uintptr_t arch_syscall_invoke3(uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t call_id)
Definition: syscall.h:111
arch_syscall_invoke6
static uintptr_t arch_syscall_invoke6(uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4, uintptr_t arg5, uintptr_t arg6, uintptr_t call_id)
Definition: syscall.h:40
SYSINL
#define SYSINL
Definition: syscall.h:39
sections.h
Definitions of various linker Sections.
uint32_t
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
uintptr_t
__UINTPTR_TYPE__ uintptr_t
Definition: stdint.h:105
util_macro.h
Macro utilities.