1 /*
2 * Copyright (c) 2006-2021, RT-Thread Development Team
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2021-05-18 Bernard port from FreeBSD
9 */
10
11 /*-
12 * Copyright (c) 2016-2017 Ruslan Bukin <br@bsdpad.com>
13 * All rights reserved.
14 * Copyright (c) 2019 Mitchell Horne <mhorne@FreeBSD.org>
15 *
16 * Portions of this software were developed by SRI International and the
17 * University of Cambridge Computer Laboratory under DARPA/AFRL contract
18 * FA8750-10-C-0237 ("CTSRD"), as part of the DARPA CRASH research programme.
19 *
20 * Portions of this software were developed by the University of Cambridge
21 * Computer Laboratory as part of the CTSRD Project, with support from the
22 * UK Higher Education Innovation Fund (HEIF).
23 *
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
26 * are met:
27 * 1. Redistributions of source code must retain the above copyright
28 * notice, this list of conditions and the following disclaimer.
29 * 2. Redistributions in binary form must reproduce the above copyright
30 * notice, this list of conditions and the following disclaimer in the
31 * documentation and/or other materials provided with the distribution.
32 *
33 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
34 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
35 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
37 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
42 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 *
45 * $FreeBSD$
46 */
47
48 #ifndef _MACHINE_SBI_H_
49 #define _MACHINE_SBI_H_
50
51 #include <stdint.h>
52 #include <rtdef.h>
53
54 /* SBI Specification Version */
55 #define SBI_SPEC_VERS_MAJOR_OFFSET 24
56 #define SBI_SPEC_VERS_MAJOR_MASK (0x7F << SBI_SPEC_VERS_MAJOR_OFFSET)
57 #define SBI_SPEC_VERS_MINOR_OFFSET 0
58 #define SBI_SPEC_VERS_MINOR_MASK (0xFFFFFF << SBI_SPEC_VERS_MINOR_OFFSET)
59
60 /* SBI Implementation IDs */
61 #define SBI_IMPL_ID_BBL 0
62 #define SBI_IMPL_ID_OPENSBI 1
63 #define SBI_IMPL_ID_XVISOR 2
64 #define SBI_IMPL_ID_KVM 3
65 #define SBI_IMPL_ID_RUSTSBI 4
66 #define SBI_IMPL_ID_DIOSIX 5
67
68 /* SBI Error Codes */
69 #define SBI_SUCCESS 0
70 #define SBI_ERR_FAILURE -1
71 #define SBI_ERR_NOT_SUPPORTED -2
72 #define SBI_ERR_INVALID_PARAM -3
73 #define SBI_ERR_DENIED -4
74 #define SBI_ERR_INVALID_ADDRESS -5
75 #define SBI_ERR_ALREADY_AVAILABLE -6
76
77 /* SBI Base Extension */
78 #define SBI_EXT_ID_BASE 0x10
79 #define SBI_BASE_GET_SPEC_VERSION 0
80 #define SBI_BASE_GET_IMPL_ID 1
81 #define SBI_BASE_GET_IMPL_VERSION 2
82 #define SBI_BASE_PROBE_EXTENSION 3
83 #define SBI_BASE_GET_MVENDORID 4
84 #define SBI_BASE_GET_MARCHID 5
85 #define SBI_BASE_GET_MIMPID 6
86
87 /* Timer (TIME) Extension */
88 #define SBI_EXT_ID_TIME 0x54494D45
89 #define SBI_TIME_SET_TIMER 0
90
91 /* IPI (IPI) Extension */
92 #define SBI_EXT_ID_IPI 0x735049
93 #define SBI_IPI_SEND_IPI 0
94
95 /* RFENCE (RFNC) Extension */
96 #define SBI_EXT_ID_RFNC 0x52464E43
97 #define SBI_RFNC_REMOTE_FENCE_I 0
98 #define SBI_RFNC_REMOTE_SFENCE_VMA 1
99 #define SBI_RFNC_REMOTE_SFENCE_VMA_ASID 2
100 #define SBI_RFNC_REMOTE_HFENCE_GVMA_VMID 3
101 #define SBI_RFNC_REMOTE_HFENCE_GVMA 4
102 #define SBI_RFNC_REMOTE_HFENCE_VVMA_ASID 5
103 #define SBI_RFNC_REMOTE_HFENCE_VVMA 6
104
105 /* Hart State Management (HSM) Extension */
106 #define SBI_EXT_ID_HSM 0x48534D
107 #define SBI_HSM_HART_START 0
108 #define SBI_HSM_HART_STOP 1
109 #define SBI_HSM_HART_STATUS 2
110 #define SBI_HSM_STATUS_STARTED 0
111 #define SBI_HSM_STATUS_STOPPED 1
112 #define SBI_HSM_STATUS_START_PENDING 2
113 #define SBI_HSM_STATUS_STOP_PENDING 3
114
115 /* Legacy Extensions */
116 #define SBI_SET_TIMER 0
117 #define SBI_CONSOLE_PUTCHAR 1
118 #define SBI_CONSOLE_GETCHAR 2
119 #define SBI_CLEAR_IPI 3
120 #define SBI_SEND_IPI 4
121 #define SBI_REMOTE_FENCE_I 5
122 #define SBI_REMOTE_SFENCE_VMA 6
123 #define SBI_REMOTE_SFENCE_VMA_ASID 7
124 #define SBI_SHUTDOWN 8
125
126 #define SBI_CALL0(e, f) SBI_CALL5(e, f, 0, 0, 0, 0, 0)
127 #define SBI_CALL1(e, f, p1) SBI_CALL5(e, f, p1, 0, 0, 0, 0)
128 #define SBI_CALL2(e, f, p1, p2) SBI_CALL5(e, f, p1, p2, 0, 0, 0)
129 #define SBI_CALL3(e, f, p1, p2, p3) SBI_CALL5(e, f, p1, p2, p3, 0, 0)
130 #define SBI_CALL4(e, f, p1, p2, p3, p4) SBI_CALL5(e, f, p1, p2, p3, p4, 0)
131 #define SBI_CALL5(e, f, p1, p2, p3, p4, p5) sbi_call(e, f, p1, p2, p3, p4, p5)
132
133 /*
134 * Documentation available at
135 * https://github.com/riscv/riscv-sbi-doc/blob/master/riscv-sbi.adoc
136 */
137
138 struct sbi_ret
139 {
140 long error;
141 long value;
142 };
143
144 rt_inline struct sbi_ret
sbi_call(uint64_t arg7,uint64_t arg6,uint64_t arg0,uint64_t arg1,uint64_t arg2,uint64_t arg3,uint64_t arg4)145 sbi_call(uint64_t arg7, uint64_t arg6, uint64_t arg0, uint64_t arg1,
146 uint64_t arg2, uint64_t arg3, uint64_t arg4)
147 {
148 struct sbi_ret ret;
149
150 register uintptr_t a0 __asm("a0") = (uintptr_t)(arg0);
151 register uintptr_t a1 __asm("a1") = (uintptr_t)(arg1);
152 register uintptr_t a2 __asm("a2") = (uintptr_t)(arg2);
153 register uintptr_t a3 __asm("a3") = (uintptr_t)(arg3);
154 register uintptr_t a4 __asm("a4") = (uintptr_t)(arg4);
155 register uintptr_t a6 __asm("a6") = (uintptr_t)(arg6);
156 register uintptr_t a7 __asm("a7") = (uintptr_t)(arg7);
157
158 __asm __volatile(\
159 "ecall" \
160 : "+r"(a0), "+r"(a1) \
161 : "r"(a2), "r"(a3), "r"(a4), "r"(a6), "r"(a7) \
162 : "memory");
163
164 ret.error = a0;
165 ret.value = a1;
166 return (ret);
167 }
168
169 /* Base extension functions and variables. */
170 extern unsigned long sbi_spec_version;
171 extern unsigned long sbi_impl_id;
172 extern unsigned long sbi_impl_version;
173
174 static __inline long
sbi_probe_extension(long id)175 sbi_probe_extension(long id)
176 {
177 return (SBI_CALL1(SBI_EXT_ID_BASE, SBI_BASE_PROBE_EXTENSION, id).value);
178 }
179
180 /* TIME extension functions. */
181 void sbi_set_timer(uint64_t val);
182
183 /* IPI extension functions. */
184 void sbi_send_ipi(const unsigned long *hart_mask);
185
186 /* RFENCE extension functions. */
187 void sbi_remote_fence_i(const unsigned long *hart_mask);
188 int sbi_remote_sfence_vma(const unsigned long *hart_mask,
189 const unsigned long hart_mask_base,
190 unsigned long start, unsigned long size);
191 void sbi_remote_sfence_vma_asid(const unsigned long *hart_mask, unsigned long start,
192 unsigned long size, unsigned long asid);
193
194 /* Hart State Management extension functions. */
195
196 /*
197 * Start execution on the specified hart at physical address start_addr. The
198 * register a0 will contain the hart's ID, and a1 will contain the value of
199 * priv.
200 */
201 int sbi_hsm_hart_start(unsigned long hart, unsigned long start_addr, unsigned long priv);
202
203 /*
204 * Stop execution on the current hart. Interrupts should be disabled, or this
205 * function may return.
206 */
207 void sbi_hsm_hart_stop(void);
208
209 /*
210 * Get the execution status of the specified hart. The status will be one of:
211 * - SBI_HSM_STATUS_STARTED
212 * - SBI_HSM_STATUS_STOPPED
213 * - SBI_HSM_STATUS_START_PENDING
214 * - SBI_HSM_STATUS_STOP_PENDING
215 */
216 int sbi_hsm_hart_status(unsigned long hart);
217
218 /* Legacy extension functions. */
219 static __inline void
sbi_console_putchar(int ch)220 sbi_console_putchar(int ch)
221 {
222 (void)SBI_CALL1(SBI_CONSOLE_PUTCHAR, 0, ch);
223 }
224
225 static __inline int
sbi_console_getchar(void)226 sbi_console_getchar(void)
227 {
228 /*
229 * XXX: The "error" is returned here because legacy SBI functions
230 * continue to return their value in a0.
231 */
232 return (SBI_CALL0(SBI_CONSOLE_GETCHAR, 0).error);
233 }
234
235 static __inline void
sbi_shutdown(void)236 sbi_shutdown(void)
237 {
238 (void)SBI_CALL0(SBI_SHUTDOWN, 0);
239 }
240
241 void sbi_print_version(void);
242 void sbi_init(void);
243
244 #endif /* !_MACHINE_SBI_H_ */
245