1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2015 Regents of the University of California
4  * Copyright (c) 2020 Western Digital Corporation or its affiliates.
5  *
6  * Taken from Linux arch/riscv/include/asm/sbi.h
7  */
8 
9 #ifndef _ASM_RISCV_SBI_H
10 #define _ASM_RISCV_SBI_H
11 
12 #include <linux/types.h>
13 
14 enum sbi_ext_id {
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 	SBI_EXT_BASE = 0x10,
25 	SBI_EXT_TIME = 0x54494D45,
26 	SBI_EXT_IPI = 0x735049,
27 	SBI_EXT_RFENCE = 0x52464E43,
28 	SBI_EXT_HSM = 0x48534D,
29 	SBI_EXT_SRST = 0x53525354,
30 	SBI_EXT_PMU = 0x504D55,
31 	SBI_EXT_DBCN = 0x4442434E,
32 	SBI_EXT_SUSP = 0x53555350,
33 	SBI_EXT_CPPC = 0x43505043,
34 	SBI_EXT_NACL = 0x4E41434C,
35 	SBI_EXT_STA = 0x535441,
36 	SBI_EXT_SSE = 0x535345,
37 	SBI_EXT_FWFT = 0x46574654,
38 	SBI_EXT_DBTR = 0x44425452,
39 	SBI_EXT_MPXY = 0x4D505859,
40 };
41 
42 enum sbi_ext_base_fid {
43 	SBI_EXT_BASE_GET_SPEC_VERSION = 0,
44 	SBI_EXT_BASE_GET_IMP_ID,
45 	SBI_EXT_BASE_GET_IMP_VERSION,
46 	SBI_EXT_BASE_PROBE_EXT,
47 	SBI_EXT_BASE_GET_MVENDORID,
48 	SBI_EXT_BASE_GET_MARCHID,
49 	SBI_EXT_BASE_GET_MIMPID,
50 };
51 
52 enum sbi_ext_time_fid {
53 	SBI_EXT_TIME_SET_TIMER = 0,
54 };
55 
56 enum sbi_ext_ipi_fid {
57 	SBI_EXT_IPI_SEND_IPI = 0,
58 };
59 
60 enum sbi_ext_rfence_fid {
61 	SBI_EXT_RFENCE_REMOTE_FENCE_I = 0,
62 	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
63 	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
64 	SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
65 	SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
66 	SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
67 	SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
68 };
69 
70 enum sbi_ext_hsm_fid {
71 	SBI_EXT_HSM_HART_START = 0,
72 	SBI_EXT_HSM_HART_STOP,
73 	SBI_EXT_HSM_HART_STATUS,
74 	SBI_EXT_HSM_HART_SUSPEND,
75 };
76 
77 enum sbi_hsm_hart_status {
78 	SBI_HSM_HART_STATUS_STARTED = 0,
79 	SBI_HSM_HART_STATUS_STOPPED,
80 	SBI_HSM_HART_STATUS_START_PENDING,
81 	SBI_HSM_HART_STATUS_STOP_PENDING,
82 	SBI_HSM_HART_STATUS_SUSPEND_PENDING,
83 	SBI_HSM_HART_STATUS_RESUME_PENDING,
84 };
85 
86 enum sbi_ext_srst_fid {
87 	SBI_EXT_SRST_RESET = 0,
88 };
89 
90 enum sbi_srst_reset_type {
91 	SBI_SRST_RESET_TYPE_SHUTDOWN = 0,
92 	SBI_SRST_RESET_TYPE_COLD_REBOOT,
93 	SBI_SRST_RESET_TYPE_WARM_REBOOT,
94 };
95 
96 enum sbi_srst_reset_reason {
97 	SBI_SRST_RESET_REASON_NONE = 0,
98 	SBI_SRST_RESET_REASON_SYS_FAILURE,
99 };
100 
101 enum sbi_ext_dbcn_fid {
102 	SBI_EXT_DBCN_CONSOLE_WRITE = 0,
103 	SBI_EXT_DBCN_CONSOLE_READ,
104 	SBI_EXT_DBCN_CONSOLE_WRITE_BYTE,
105 };
106 
107 #ifdef CONFIG_SBI_V01
108 #define SBI_EXT_SET_TIMER		SBI_EXT_0_1_SET_TIMER
109 #define SBI_FID_SET_TIMER		0
110 #define SBI_EXT_SEND_IPI		SBI_EXT_0_1_SEND_IPI
111 #define SBI_FID_SEND_IPI		0
112 #define SBI_EXT_REMOTE_FENCE_I		SBI_EXT_0_1_REMOTE_FENCE_I
113 #define SBI_FID_REMOTE_FENCE_I		0
114 #define SBI_EXT_REMOTE_SFENCE_VMA	SBI_EXT_0_1_REMOTE_SFENCE_VMA
115 #define SBI_FID_REMOTE_SFENCE_VMA	0
116 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID	SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID
117 #define SBI_FID_REMOTE_SFENCE_VMA_ASID	0
118 #else
119 #define SBI_EXT_SET_TIMER		SBI_EXT_TIME
120 #define SBI_FID_SET_TIMER		SBI_EXT_TIME_SET_TIMER
121 #define SBI_EXT_SEND_IPI		SBI_EXT_IPI
122 #define SBI_FID_SEND_IPI		SBI_EXT_IPI_SEND_IPI
123 #define SBI_EXT_REMOTE_FENCE_I		SBI_EXT_RFENCE
124 #define SBI_FID_REMOTE_FENCE_I		SBI_EXT_RFENCE_REMOTE_FENCE_I
125 #define SBI_EXT_REMOTE_SFENCE_VMA	SBI_EXT_RFENCE
126 #define SBI_FID_REMOTE_SFENCE_VMA	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA
127 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID	SBI_EXT_RFENCE
128 #define SBI_FID_REMOTE_SFENCE_VMA_ASID	SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID
129 #endif
130 
131 #define SBI_SPEC_VERSION_MAJOR_SHIFT	24
132 #define SBI_SPEC_VERSION_MAJOR_MASK	0x7f
133 #define SBI_SPEC_VERSION_MINOR_MASK	0xffffff
134 
135 /* SBI return error codes */
136 #define SBI_SUCCESS			0
137 #define SBI_ERR_FAILURE			-1
138 #define SBI_ERR_NOT_SUPPORTED		-2
139 #define SBI_ERR_INVALID_PARAM		-3
140 #define SBI_ERR_DENIED			-4
141 #define SBI_ERR_INVALID_ADDRESS		-5
142 
143 struct sbiret {
144 	long error;
145 	long value;
146 };
147 
148 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
149 			unsigned long arg1, unsigned long arg2,
150 			unsigned long arg3, unsigned long arg4,
151 			unsigned long arg5);
152 
153 #ifdef CONFIG_SBI_V01
154 void sbi_console_putchar(int ch);
155 int sbi_console_getchar(void);
156 void sbi_clear_ipi(void);
157 void sbi_shutdown(void);
158 void sbi_send_ipi(const unsigned long *hart_mask);
159 void sbi_remote_fence_i(const unsigned long *hart_mask);
160 void sbi_remote_sfence_vma(const unsigned long *hart_mask,
161 			   unsigned long start,
162 			   unsigned long size);
163 void sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
164 				unsigned long start,
165 				unsigned long size,
166 				unsigned long asid);
167 #endif
168 void sbi_set_timer(uint64_t stime_value);
169 long sbi_get_spec_version(void);
170 int sbi_get_impl_id(void);
171 int sbi_get_impl_version(long *version);
172 int sbi_probe_extension(int ext);
173 int sbi_get_mvendorid(long *mvendorid);
174 int sbi_get_marchid(long *marchid);
175 int sbi_get_mimpid(long *mimpid);
176 void sbi_srst_reset(unsigned long type, unsigned long reason);
177 int sbi_dbcn_write_byte(unsigned char ch);
178 
179 #endif
180