xref: /openbmc/linux/arch/riscv/include/asm/sbi.h (revision 6e10e219)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2015 Regents of the University of California
4  * Copyright (c) 2020 Western Digital Corporation or its affiliates.
5  */
6 
7 #ifndef _ASM_RISCV_SBI_H
8 #define _ASM_RISCV_SBI_H
9 
10 #include <linux/types.h>
11 
12 #ifdef CONFIG_RISCV_SBI
13 enum sbi_ext_id {
14 #ifdef CONFIG_RISCV_SBI_V01
15 	SBI_EXT_0_1_SET_TIMER = 0x0,
16 	SBI_EXT_0_1_CONSOLE_PUTCHAR = 0x1,
17 	SBI_EXT_0_1_CONSOLE_GETCHAR = 0x2,
18 	SBI_EXT_0_1_CLEAR_IPI = 0x3,
19 	SBI_EXT_0_1_SEND_IPI = 0x4,
20 	SBI_EXT_0_1_REMOTE_FENCE_I = 0x5,
21 	SBI_EXT_0_1_REMOTE_SFENCE_VMA = 0x6,
22 	SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID = 0x7,
23 	SBI_EXT_0_1_SHUTDOWN = 0x8,
24 #endif
25 	SBI_EXT_BASE = 0x10,
26 	SBI_EXT_TIME = 0x54494D45,
27 	SBI_EXT_IPI = 0x735049,
28 	SBI_EXT_RFENCE = 0x52464E43,
29 	SBI_EXT_HSM = 0x48534D,
30 
31 	/* Experimentals extensions must lie within this range */
32 	SBI_EXT_EXPERIMENTAL_START = 0x08000000,
33 	SBI_EXT_EXPERIMENTAL_END = 0x08FFFFFF,
34 
35 	/* Vendor extensions must lie within this range */
36 	SBI_EXT_VENDOR_START = 0x09000000,
37 	SBI_EXT_VENDOR_END = 0x09FFFFFF,
38 };
39 
40 enum sbi_ext_base_fid {
41 	SBI_EXT_BASE_GET_SPEC_VERSION = 0,
42 	SBI_EXT_BASE_GET_IMP_ID,
43 	SBI_EXT_BASE_GET_IMP_VERSION,
44 	SBI_EXT_BASE_PROBE_EXT,
45 	SBI_EXT_BASE_GET_MVENDORID,
46 	SBI_EXT_BASE_GET_MARCHID,
47 	SBI_EXT_BASE_GET_MIMPID,
48 };
49 
50 enum sbi_ext_time_fid {
51 	SBI_EXT_TIME_SET_TIMER = 0,
52 };
53 
54 enum sbi_ext_ipi_fid {
55 	SBI_EXT_IPI_SEND_IPI = 0,
56 };
57 
58 enum sbi_ext_rfence_fid {
59 	SBI_EXT_RFENCE_REMOTE_FENCE_I = 0,
60 	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
61 	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
62 	SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
63 	SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
64 	SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
65 	SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
66 };
67 
68 enum sbi_ext_hsm_fid {
69 	SBI_EXT_HSM_HART_START = 0,
70 	SBI_EXT_HSM_HART_STOP,
71 	SBI_EXT_HSM_HART_STATUS,
72 };
73 
74 enum sbi_hsm_hart_status {
75 	SBI_HSM_HART_STATUS_STARTED = 0,
76 	SBI_HSM_HART_STATUS_STOPPED,
77 	SBI_HSM_HART_STATUS_START_PENDING,
78 	SBI_HSM_HART_STATUS_STOP_PENDING,
79 };
80 
81 #define SBI_SPEC_VERSION_DEFAULT	0x1
82 #define SBI_SPEC_VERSION_MAJOR_SHIFT	24
83 #define SBI_SPEC_VERSION_MAJOR_MASK	0x7f
84 #define SBI_SPEC_VERSION_MINOR_MASK	0xffffff
85 
86 /* SBI return error codes */
87 #define SBI_SUCCESS		0
88 #define SBI_ERR_FAILURE		-1
89 #define SBI_ERR_NOT_SUPPORTED	-2
90 #define SBI_ERR_INVALID_PARAM	-3
91 #define SBI_ERR_DENIED		-4
92 #define SBI_ERR_INVALID_ADDRESS	-5
93 #define SBI_ERR_ALREADY_AVAILABLE -6
94 
95 extern unsigned long sbi_spec_version;
96 struct sbiret {
97 	long error;
98 	long value;
99 };
100 
101 void sbi_init(void);
102 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
103 			unsigned long arg1, unsigned long arg2,
104 			unsigned long arg3, unsigned long arg4,
105 			unsigned long arg5);
106 
107 void sbi_console_putchar(int ch);
108 int sbi_console_getchar(void);
109 long sbi_get_mvendorid(void);
110 long sbi_get_marchid(void);
111 long sbi_get_mimpid(void);
112 void sbi_set_timer(uint64_t stime_value);
113 void sbi_shutdown(void);
114 void sbi_clear_ipi(void);
115 int sbi_send_ipi(const unsigned long *hart_mask);
116 int sbi_remote_fence_i(const unsigned long *hart_mask);
117 int sbi_remote_sfence_vma(const unsigned long *hart_mask,
118 			   unsigned long start,
119 			   unsigned long size);
120 
121 int sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
122 				unsigned long start,
123 				unsigned long size,
124 				unsigned long asid);
125 int sbi_remote_hfence_gvma(const unsigned long *hart_mask,
126 			   unsigned long start,
127 			   unsigned long size);
128 int sbi_remote_hfence_gvma_vmid(const unsigned long *hart_mask,
129 				unsigned long start,
130 				unsigned long size,
131 				unsigned long vmid);
132 int sbi_remote_hfence_vvma(const unsigned long *hart_mask,
133 			   unsigned long start,
134 			   unsigned long size);
135 int sbi_remote_hfence_vvma_asid(const unsigned long *hart_mask,
136 				unsigned long start,
137 				unsigned long size,
138 				unsigned long asid);
139 int sbi_probe_extension(int ext);
140 
141 /* Check if current SBI specification version is 0.1 or not */
142 static inline int sbi_spec_is_0_1(void)
143 {
144 	return (sbi_spec_version == SBI_SPEC_VERSION_DEFAULT) ? 1 : 0;
145 }
146 
147 /* Get the major version of SBI */
148 static inline unsigned long sbi_major_version(void)
149 {
150 	return (sbi_spec_version >> SBI_SPEC_VERSION_MAJOR_SHIFT) &
151 		SBI_SPEC_VERSION_MAJOR_MASK;
152 }
153 
154 /* Get the minor version of SBI */
155 static inline unsigned long sbi_minor_version(void)
156 {
157 	return sbi_spec_version & SBI_SPEC_VERSION_MINOR_MASK;
158 }
159 
160 int sbi_err_map_linux_errno(int err);
161 #else /* CONFIG_RISCV_SBI */
162 static inline int sbi_remote_fence_i(const unsigned long *hart_mask) { return -1; }
163 static inline void sbi_init(void) {}
164 #endif /* CONFIG_RISCV_SBI */
165 #endif /* _ASM_RISCV_SBI_H */
166