2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 Mitchell Horne <mhorne@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/systm.h>
34 #include <sys/types.h>
35 #include <sys/eventhandler.h>
36 #include <sys/reboot.h>
38 #include <machine/md_var.h>
39 #include <machine/sbi.h>
41 /* SBI Implementation-Specific Definitions */
42 #define OPENSBI_VERSION_MAJOR_OFFSET 16
43 #define OPENSBI_VERSION_MINOR_MASK 0xFFFF
45 u_long sbi_spec_version;
47 u_long sbi_impl_version;
49 static bool has_time_extension = false;
50 static bool has_ipi_extension = false;
51 static bool has_rfnc_extension = false;
52 static bool has_srst_extension = false;
55 sbi_get_spec_version(void)
57 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_SPEC_VERSION));
63 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_IMPL_ID));
67 sbi_get_impl_version(void)
69 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_IMPL_VERSION));
73 sbi_get_mvendorid(void)
75 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MVENDORID));
81 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MARCHID));
87 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MIMPID));
91 sbi_shutdown_final(void *dummy __unused, int howto)
93 if ((howto & RB_POWEROFF) != 0)
94 sbi_system_reset(SBI_SRST_TYPE_SHUTDOWN, SBI_SRST_REASON_NONE);
98 sbi_system_reset(u_long reset_type, u_long reset_reason)
100 /* Use the SRST extension, if available. */
101 if (has_srst_extension) {
102 (void)SBI_CALL2(SBI_EXT_ID_SRST, SBI_SRST_SYSTEM_RESET,
103 reset_type, reset_reason);
105 (void)SBI_CALL0(SBI_SHUTDOWN, 0);
109 sbi_print_version(void)
114 /* For legacy SBI implementations. */
115 if (sbi_spec_version == 0) {
116 printf("SBI: Unknown (Legacy) Implementation\n");
117 printf("SBI Specification Version: 0.1\n");
121 switch (sbi_impl_id) {
122 case (SBI_IMPL_ID_BBL):
123 printf("SBI: Berkely Boot Loader %lu\n", sbi_impl_version);
125 case (SBI_IMPL_ID_XVISOR):
126 printf("SBI: eXtensible Versatile hypervISOR %lu\n",
129 case (SBI_IMPL_ID_KVM):
130 printf("SBI: Kernel-based Virtual Machine %lu\n",
133 case (SBI_IMPL_ID_RUSTSBI):
134 printf("SBI: RustSBI %lu\n", sbi_impl_version);
136 case (SBI_IMPL_ID_DIOSIX):
137 printf("SBI: Diosix %lu\n", sbi_impl_version);
139 case (SBI_IMPL_ID_OPENSBI):
140 major = sbi_impl_version >> OPENSBI_VERSION_MAJOR_OFFSET;
141 minor = sbi_impl_version & OPENSBI_VERSION_MINOR_MASK;
142 printf("SBI: OpenSBI v%u.%u\n", major, minor);
145 printf("SBI: Unrecognized Implementation: %lu\n", sbi_impl_id);
149 major = (sbi_spec_version & SBI_SPEC_VERS_MAJOR_MASK) >>
150 SBI_SPEC_VERS_MAJOR_OFFSET;
151 minor = (sbi_spec_version & SBI_SPEC_VERS_MINOR_MASK);
152 printf("SBI Specification Version: %u.%u\n", major, minor);
156 sbi_set_timer(uint64_t val)
160 /* Use the TIME legacy replacement extension, if available. */
161 if (has_time_extension) {
162 ret = SBI_CALL1(SBI_EXT_ID_TIME, SBI_TIME_SET_TIMER, val);
163 MPASS(ret.error == SBI_SUCCESS);
165 (void)SBI_CALL1(SBI_SET_TIMER, 0, val);
170 sbi_send_ipi(const u_long *hart_mask)
174 /* Use the IPI legacy replacement extension, if available. */
175 if (has_ipi_extension) {
176 ret = SBI_CALL2(SBI_EXT_ID_IPI, SBI_IPI_SEND_IPI,
178 MPASS(ret.error == SBI_SUCCESS);
180 (void)SBI_CALL1(SBI_SEND_IPI, 0, (uint64_t)hart_mask);
185 sbi_remote_fence_i(const u_long *hart_mask)
189 /* Use the RFENCE legacy replacement extension, if available. */
190 if (has_rfnc_extension) {
191 ret = SBI_CALL2(SBI_EXT_ID_RFNC, SBI_RFNC_REMOTE_FENCE_I,
193 MPASS(ret.error == SBI_SUCCESS);
195 (void)SBI_CALL1(SBI_REMOTE_FENCE_I, 0, (uint64_t)hart_mask);
200 sbi_remote_sfence_vma(const u_long *hart_mask, u_long start, u_long size)
204 /* Use the RFENCE legacy replacement extension, if available. */
205 if (has_rfnc_extension) {
206 ret = SBI_CALL4(SBI_EXT_ID_RFNC, SBI_RFNC_REMOTE_SFENCE_VMA,
207 *hart_mask, 0, start, size);
208 MPASS(ret.error == SBI_SUCCESS);
210 (void)SBI_CALL3(SBI_REMOTE_SFENCE_VMA, 0, (uint64_t)hart_mask,
216 sbi_remote_sfence_vma_asid(const u_long *hart_mask, u_long start, u_long size,
221 /* Use the RFENCE legacy replacement extension, if available. */
222 if (has_rfnc_extension) {
223 ret = SBI_CALL5(SBI_EXT_ID_RFNC,
224 SBI_RFNC_REMOTE_SFENCE_VMA_ASID, *hart_mask, 0, start,
226 MPASS(ret.error == SBI_SUCCESS);
228 (void)SBI_CALL4(SBI_REMOTE_SFENCE_VMA_ASID, 0,
229 (uint64_t)hart_mask, start, size, asid);
234 sbi_hsm_hart_start(u_long hart, u_long start_addr, u_long priv)
238 ret = SBI_CALL3(SBI_EXT_ID_HSM, SBI_HSM_HART_START, hart, start_addr,
240 return (ret.error != 0 ? (int)ret.error : 0);
244 sbi_hsm_hart_stop(void)
246 (void)SBI_CALL0(SBI_EXT_ID_HSM, SBI_HSM_HART_STOP);
250 sbi_hsm_hart_status(u_long hart)
254 ret = SBI_CALL1(SBI_EXT_ID_HSM, SBI_HSM_HART_STATUS, hart);
256 return (ret.error != 0 ? (int)ret.error : (int)ret.value);
265 * Get the spec version. For legacy SBI implementations this will
266 * return an error, otherwise it is guaranteed to succeed.
268 sret = sbi_get_spec_version();
269 if (sret.error != 0) {
270 /* We are running a legacy SBI implementation. */
271 sbi_spec_version = 0;
275 /* Set the SBI implementation info. */
276 sbi_spec_version = sret.value;
277 sbi_impl_id = sbi_get_impl_id().value;
278 sbi_impl_version = sbi_get_impl_version().value;
280 /* Set the hardware implementation info. */
281 mvendorid = sbi_get_mvendorid().value;
282 marchid = sbi_get_marchid().value;
283 mimpid = sbi_get_mimpid().value;
285 /* Probe for legacy replacement extensions. */
286 if (sbi_probe_extension(SBI_EXT_ID_TIME) != 0)
287 has_time_extension = true;
288 if (sbi_probe_extension(SBI_EXT_ID_IPI) != 0)
289 has_ipi_extension = true;
290 if (sbi_probe_extension(SBI_EXT_ID_RFNC) != 0)
291 has_rfnc_extension = true;
292 if (sbi_probe_extension(SBI_EXT_ID_SRST) != 0)
293 has_srst_extension = true;
296 * Probe for legacy extensions. We still rely on many of them to be
297 * implemented, but this is not guaranteed by the spec.
299 KASSERT(has_time_extension || sbi_probe_extension(SBI_SET_TIMER) != 0,
300 ("SBI doesn't implement sbi_set_timer()"));
301 KASSERT(sbi_probe_extension(SBI_CONSOLE_PUTCHAR) != 0,
302 ("SBI doesn't implement sbi_console_putchar()"));
303 KASSERT(sbi_probe_extension(SBI_CONSOLE_GETCHAR) != 0,
304 ("SBI doesn't implement sbi_console_getchar()"));
305 KASSERT(has_ipi_extension || sbi_probe_extension(SBI_SEND_IPI) != 0,
306 ("SBI doesn't implement sbi_send_ipi()"));
307 KASSERT(has_rfnc_extension ||
308 sbi_probe_extension(SBI_REMOTE_FENCE_I) != 0,
309 ("SBI doesn't implement sbi_remote_fence_i()"));
310 KASSERT(has_rfnc_extension ||
311 sbi_probe_extension(SBI_REMOTE_SFENCE_VMA) != 0,
312 ("SBI doesn't implement sbi_remote_sfence_vma()"));
313 KASSERT(has_rfnc_extension ||
314 sbi_probe_extension(SBI_REMOTE_SFENCE_VMA_ASID) != 0,
315 ("SBI doesn't implement sbi_remote_sfence_vma_asid()"));
316 KASSERT(has_srst_extension || sbi_probe_extension(SBI_SHUTDOWN) != 0,
317 ("SBI doesn't implement a shutdown or reset extension"));
321 sbi_late_init(void *dummy __unused)
323 EVENTHANDLER_REGISTER(shutdown_final, sbi_shutdown_final, NULL,
327 SYSINIT(sbi, SI_SUB_KLD, SI_ORDER_ANY, sbi_late_init, NULL);