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;
54 sbi_get_spec_version(void)
56 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_SPEC_VERSION));
62 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_IMPL_ID));
66 sbi_get_impl_version(void)
68 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_IMPL_VERSION));
72 sbi_get_mvendorid(void)
74 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MVENDORID));
80 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MARCHID));
86 return (SBI_CALL0(SBI_EXT_ID_BASE, SBI_BASE_GET_MIMPID));
90 sbi_shutdown_final(void *dummy __unused, int howto)
92 if ((howto & RB_POWEROFF) != 0)
97 sbi_print_version(void)
102 /* For legacy SBI implementations. */
103 if (sbi_spec_version == 0) {
104 printf("SBI: Unknown (Legacy) Implementation\n");
105 printf("SBI Specification Version: 0.1\n");
109 switch (sbi_impl_id) {
110 case (SBI_IMPL_ID_BBL):
111 printf("SBI: Berkely Boot Loader %lu\n", sbi_impl_version);
113 case (SBI_IMPL_ID_XVISOR):
114 printf("SBI: eXtensible Versatile hypervISOR %lu\n", sbi_impl_version);
116 case (SBI_IMPL_ID_KVM):
117 printf("SBI: Kernel-based Virtual Machine %lu\n", sbi_impl_version);
119 case (SBI_IMPL_ID_RUSTSBI):
120 printf("SBI: RustSBI %lu\n", sbi_impl_version);
122 case (SBI_IMPL_ID_DIOSIX):
123 printf("SBI: Diosix %lu\n", sbi_impl_version);
125 case (SBI_IMPL_ID_OPENSBI):
126 major = sbi_impl_version >> OPENSBI_VERSION_MAJOR_OFFSET;
127 minor = sbi_impl_version & OPENSBI_VERSION_MINOR_MASK;
128 printf("SBI: OpenSBI v%u.%u\n", major, minor);
131 printf("SBI: Unrecognized Implementation: %lu\n", sbi_impl_id);
135 major = (sbi_spec_version & SBI_SPEC_VERS_MAJOR_MASK) >>
136 SBI_SPEC_VERS_MAJOR_OFFSET;
137 minor = (sbi_spec_version & SBI_SPEC_VERS_MINOR_MASK);
138 printf("SBI Specification Version: %u.%u\n", major, minor);
142 sbi_set_timer(uint64_t val)
146 /* Use the TIME legacy replacement extension, if available. */
147 if (has_time_extension) {
148 ret = SBI_CALL1(SBI_EXT_ID_TIME, SBI_TIME_SET_TIMER, val);
149 MPASS(ret.error == SBI_SUCCESS);
151 (void)SBI_CALL1(SBI_SET_TIMER, 0, val);
156 sbi_send_ipi(const u_long *hart_mask)
160 /* Use the IPI legacy replacement extension, if available. */
161 if (has_ipi_extension) {
162 ret = SBI_CALL2(SBI_EXT_ID_IPI, SBI_IPI_SEND_IPI,
164 MPASS(ret.error == SBI_SUCCESS);
166 (void)SBI_CALL1(SBI_SEND_IPI, 0, (uint64_t)hart_mask);
171 sbi_remote_fence_i(const u_long *hart_mask)
175 /* Use the RFENCE legacy replacement extension, if available. */
176 if (has_rfnc_extension) {
177 ret = SBI_CALL2(SBI_EXT_ID_RFNC, SBI_RFNC_REMOTE_FENCE_I,
179 MPASS(ret.error == SBI_SUCCESS);
181 (void)SBI_CALL1(SBI_REMOTE_FENCE_I, 0, (uint64_t)hart_mask);
186 sbi_remote_sfence_vma(const u_long *hart_mask, u_long start, u_long size)
190 /* Use the RFENCE legacy replacement extension, if available. */
191 if (has_rfnc_extension) {
192 ret = SBI_CALL4(SBI_EXT_ID_RFNC, SBI_RFNC_REMOTE_SFENCE_VMA,
193 *hart_mask, 0, start, size);
194 MPASS(ret.error == SBI_SUCCESS);
196 (void)SBI_CALL3(SBI_REMOTE_SFENCE_VMA, 0, (uint64_t)hart_mask,
202 sbi_remote_sfence_vma_asid(const u_long *hart_mask, u_long start, u_long size,
207 /* Use the RFENCE legacy replacement extension, if available. */
208 if (has_rfnc_extension) {
209 ret = SBI_CALL5(SBI_EXT_ID_RFNC, SBI_RFNC_REMOTE_SFENCE_VMA_ASID,
210 *hart_mask, 0, start, size, asid);
211 MPASS(ret.error == SBI_SUCCESS);
213 (void)SBI_CALL4(SBI_REMOTE_SFENCE_VMA_ASID, 0,
214 (uint64_t)hart_mask, start, size, asid);
219 sbi_hsm_hart_start(u_long hart, u_long start_addr, u_long priv)
223 ret = SBI_CALL3(SBI_EXT_ID_HSM, SBI_HSM_HART_START, hart, start_addr, priv);
224 return (ret.error != 0 ? (int)ret.error : 0);
228 sbi_hsm_hart_stop(void)
230 (void)SBI_CALL0(SBI_EXT_ID_HSM, SBI_HSM_HART_STOP);
234 sbi_hsm_hart_status(u_long hart)
238 ret = SBI_CALL1(SBI_EXT_ID_HSM, SBI_HSM_HART_STATUS, hart);
240 return (ret.error != 0 ? (int)ret.error : (int)ret.value);
249 * Get the spec version. For legacy SBI implementations this will
250 * return an error, otherwise it is guaranteed to succeed.
252 sret = sbi_get_spec_version();
253 if (sret.error != 0) {
254 /* We are running a legacy SBI implementation. */
255 sbi_spec_version = 0;
259 /* Set the SBI implementation info. */
260 sbi_spec_version = sret.value;
261 sbi_impl_id = sbi_get_impl_id().value;
262 sbi_impl_version = sbi_get_impl_version().value;
264 /* Set the hardware implementation info. */
265 mvendorid = sbi_get_mvendorid().value;
266 marchid = sbi_get_marchid().value;
267 mimpid = sbi_get_mimpid().value;
269 /* Probe for legacy replacement extensions. */
270 if (sbi_probe_extension(SBI_EXT_ID_TIME) != 0)
271 has_time_extension = true;
272 if (sbi_probe_extension(SBI_EXT_ID_IPI) != 0)
273 has_ipi_extension = true;
274 if (sbi_probe_extension(SBI_EXT_ID_RFNC) != 0)
275 has_rfnc_extension = true;
278 * Probe for legacy extensions. We still rely on many of them to be
279 * implemented, but this is not guaranteed by the spec.
281 KASSERT(has_time_extension || sbi_probe_extension(SBI_SET_TIMER) != 0,
282 ("SBI doesn't implement sbi_set_timer()"));
283 KASSERT(sbi_probe_extension(SBI_CONSOLE_PUTCHAR) != 0,
284 ("SBI doesn't implement sbi_console_putchar()"));
285 KASSERT(sbi_probe_extension(SBI_CONSOLE_GETCHAR) != 0,
286 ("SBI doesn't implement sbi_console_getchar()"));
287 KASSERT(has_ipi_extension || sbi_probe_extension(SBI_SEND_IPI) != 0,
288 ("SBI doesn't implement sbi_send_ipi()"));
289 KASSERT(has_rfnc_extension ||
290 sbi_probe_extension(SBI_REMOTE_FENCE_I) != 0,
291 ("SBI doesn't implement sbi_remote_fence_i()"));
292 KASSERT(has_rfnc_extension ||
293 sbi_probe_extension(SBI_REMOTE_SFENCE_VMA) != 0,
294 ("SBI doesn't implement sbi_remote_sfence_vma()"));
295 KASSERT(has_rfnc_extension ||
296 sbi_probe_extension(SBI_REMOTE_SFENCE_VMA_ASID) != 0,
297 ("SBI doesn't implement sbi_remote_sfence_vma_asid()"));
298 KASSERT(sbi_probe_extension(SBI_SHUTDOWN) != 0,
299 ("SBI doesn't implement sbi_shutdown()"));
303 sbi_late_init(void *dummy __unused)
305 EVENTHANDLER_REGISTER(shutdown_final, sbi_shutdown_final, NULL,
309 SYSINIT(sbi, SI_SUB_KLD, SI_ORDER_ANY, sbi_late_init, NULL);