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