xref: /openbmc/linux/arch/riscv/include/asm/insn.h (revision cabce92d)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2020 SiFive
4  */
5 
6 #ifndef _ASM_RISCV_INSN_H
7 #define _ASM_RISCV_INSN_H
8 
9 #include <linux/bits.h>
10 
11 #define RV_INSN_FUNCT3_MASK	GENMASK(14, 12)
12 #define RV_INSN_FUNCT3_OPOFF	12
13 #define RV_INSN_OPCODE_MASK	GENMASK(6, 0)
14 #define RV_INSN_OPCODE_OPOFF	0
15 #define RV_INSN_FUNCT12_OPOFF	20
16 
17 #define RV_ENCODE_FUNCT3(f_)	(RVG_FUNCT3_##f_ << RV_INSN_FUNCT3_OPOFF)
18 #define RV_ENCODE_FUNCT12(f_)	(RVG_FUNCT12_##f_ << RV_INSN_FUNCT12_OPOFF)
19 
20 /* The bit field of immediate value in I-type instruction */
21 #define RV_I_IMM_SIGN_OPOFF	31
22 #define RV_I_IMM_11_0_OPOFF	20
23 #define RV_I_IMM_SIGN_OFF	12
24 #define RV_I_IMM_11_0_OFF	0
25 #define RV_I_IMM_11_0_MASK	GENMASK(11, 0)
26 
27 /* The bit field of immediate value in J-type instruction */
28 #define RV_J_IMM_SIGN_OPOFF	31
29 #define RV_J_IMM_10_1_OPOFF	21
30 #define RV_J_IMM_11_OPOFF	20
31 #define RV_J_IMM_19_12_OPOFF	12
32 #define RV_J_IMM_SIGN_OFF	20
33 #define RV_J_IMM_10_1_OFF	1
34 #define RV_J_IMM_11_OFF		11
35 #define RV_J_IMM_19_12_OFF	12
36 #define RV_J_IMM_10_1_MASK	GENMASK(9, 0)
37 #define RV_J_IMM_11_MASK	GENMASK(0, 0)
38 #define RV_J_IMM_19_12_MASK	GENMASK(7, 0)
39 
40 /*
41  * U-type IMMs contain the upper 20bits [31:20] of an immediate with
42  * the rest filled in by zeros, so no shifting required. Similarly,
43  * bit31 contains the signed state, so no sign extension necessary.
44  */
45 #define RV_U_IMM_SIGN_OPOFF	31
46 #define RV_U_IMM_31_12_OPOFF	0
47 #define RV_U_IMM_31_12_MASK	GENMASK(31, 12)
48 
49 /* The bit field of immediate value in B-type instruction */
50 #define RV_B_IMM_SIGN_OPOFF	31
51 #define RV_B_IMM_10_5_OPOFF	25
52 #define RV_B_IMM_4_1_OPOFF	8
53 #define RV_B_IMM_11_OPOFF	7
54 #define RV_B_IMM_SIGN_OFF	12
55 #define RV_B_IMM_10_5_OFF	5
56 #define RV_B_IMM_4_1_OFF	1
57 #define RV_B_IMM_11_OFF		11
58 #define RV_B_IMM_10_5_MASK	GENMASK(5, 0)
59 #define RV_B_IMM_4_1_MASK	GENMASK(3, 0)
60 #define RV_B_IMM_11_MASK	GENMASK(0, 0)
61 
62 /* The register offset in RVG instruction */
63 #define RVG_RS1_OPOFF		15
64 #define RVG_RS2_OPOFF		20
65 #define RVG_RD_OPOFF		7
66 #define RVG_RD_MASK		GENMASK(4, 0)
67 
68 /* The bit field of immediate value in RVC J instruction */
69 #define RVC_J_IMM_SIGN_OPOFF	12
70 #define RVC_J_IMM_4_OPOFF	11
71 #define RVC_J_IMM_9_8_OPOFF	9
72 #define RVC_J_IMM_10_OPOFF	8
73 #define RVC_J_IMM_6_OPOFF	7
74 #define RVC_J_IMM_7_OPOFF	6
75 #define RVC_J_IMM_3_1_OPOFF	3
76 #define RVC_J_IMM_5_OPOFF	2
77 #define RVC_J_IMM_SIGN_OFF	11
78 #define RVC_J_IMM_4_OFF		4
79 #define RVC_J_IMM_9_8_OFF	8
80 #define RVC_J_IMM_10_OFF	10
81 #define RVC_J_IMM_6_OFF		6
82 #define RVC_J_IMM_7_OFF		7
83 #define RVC_J_IMM_3_1_OFF	1
84 #define RVC_J_IMM_5_OFF		5
85 #define RVC_J_IMM_4_MASK	GENMASK(0, 0)
86 #define RVC_J_IMM_9_8_MASK	GENMASK(1, 0)
87 #define RVC_J_IMM_10_MASK	GENMASK(0, 0)
88 #define RVC_J_IMM_6_MASK	GENMASK(0, 0)
89 #define RVC_J_IMM_7_MASK	GENMASK(0, 0)
90 #define RVC_J_IMM_3_1_MASK	GENMASK(2, 0)
91 #define RVC_J_IMM_5_MASK	GENMASK(0, 0)
92 
93 /* The bit field of immediate value in RVC B instruction */
94 #define RVC_B_IMM_SIGN_OPOFF	12
95 #define RVC_B_IMM_4_3_OPOFF	10
96 #define RVC_B_IMM_7_6_OPOFF	5
97 #define RVC_B_IMM_2_1_OPOFF	3
98 #define RVC_B_IMM_5_OPOFF	2
99 #define RVC_B_IMM_SIGN_OFF	8
100 #define RVC_B_IMM_4_3_OFF	3
101 #define RVC_B_IMM_7_6_OFF	6
102 #define RVC_B_IMM_2_1_OFF	1
103 #define RVC_B_IMM_5_OFF		5
104 #define RVC_B_IMM_4_3_MASK	GENMASK(1, 0)
105 #define RVC_B_IMM_7_6_MASK	GENMASK(1, 0)
106 #define RVC_B_IMM_2_1_MASK	GENMASK(1, 0)
107 #define RVC_B_IMM_5_MASK	GENMASK(0, 0)
108 
109 #define RVC_INSN_FUNCT4_MASK	GENMASK(15, 12)
110 #define RVC_INSN_FUNCT4_OPOFF	12
111 #define RVC_INSN_FUNCT3_MASK	GENMASK(15, 13)
112 #define RVC_INSN_FUNCT3_OPOFF	13
113 #define RVC_INSN_J_RS2_MASK	GENMASK(6, 2)
114 #define RVC_INSN_OPCODE_MASK	GENMASK(1, 0)
115 #define RVC_ENCODE_FUNCT3(f_)	(RVC_FUNCT3_##f_ << RVC_INSN_FUNCT3_OPOFF)
116 #define RVC_ENCODE_FUNCT4(f_)	(RVC_FUNCT4_##f_ << RVC_INSN_FUNCT4_OPOFF)
117 
118 /* The register offset in RVC op=C0 instruction */
119 #define RVC_C0_RS1_OPOFF	7
120 #define RVC_C0_RS2_OPOFF	2
121 #define RVC_C0_RD_OPOFF		2
122 
123 /* The register offset in RVC op=C1 instruction */
124 #define RVC_C1_RS1_OPOFF	7
125 #define RVC_C1_RS2_OPOFF	2
126 #define RVC_C1_RD_OPOFF		7
127 
128 /* The register offset in RVC op=C2 instruction */
129 #define RVC_C2_RS1_OPOFF	7
130 #define RVC_C2_RS2_OPOFF	2
131 #define RVC_C2_RD_OPOFF		7
132 
133 /* parts of opcode for RVG*/
134 #define RVG_OPCODE_FENCE	0x0f
135 #define RVG_OPCODE_AUIPC	0x17
136 #define RVG_OPCODE_BRANCH	0x63
137 #define RVG_OPCODE_JALR		0x67
138 #define RVG_OPCODE_JAL		0x6f
139 #define RVG_OPCODE_SYSTEM	0x73
140 #define RVG_SYSTEM_CSR_OFF	20
141 #define RVG_SYSTEM_CSR_MASK	GENMASK(12, 0)
142 
143 /* parts of opcode for RVF, RVD and RVQ */
144 #define RVFDQ_FL_FS_WIDTH_OFF	12
145 #define RVFDQ_FL_FS_WIDTH_MASK	GENMASK(3, 0)
146 #define RVFDQ_FL_FS_WIDTH_W	2
147 #define RVFDQ_FL_FS_WIDTH_D	3
148 #define RVFDQ_LS_FS_WIDTH_Q	4
149 #define RVFDQ_OPCODE_FL		0x07
150 #define RVFDQ_OPCODE_FS		0x27
151 
152 /* parts of opcode for RVV */
153 #define RVV_OPCODE_VECTOR	0x57
154 #define RVV_VL_VS_WIDTH_8	0
155 #define RVV_VL_VS_WIDTH_16	5
156 #define RVV_VL_VS_WIDTH_32	6
157 #define RVV_VL_VS_WIDTH_64	7
158 #define RVV_OPCODE_VL		RVFDQ_OPCODE_FL
159 #define RVV_OPCODE_VS		RVFDQ_OPCODE_FS
160 
161 /* parts of opcode for RVC*/
162 #define RVC_OPCODE_C0		0x0
163 #define RVC_OPCODE_C1		0x1
164 #define RVC_OPCODE_C2		0x2
165 
166 /* parts of funct3 code for I, M, A extension*/
167 #define RVG_FUNCT3_JALR		0x0
168 #define RVG_FUNCT3_BEQ		0x0
169 #define RVG_FUNCT3_BNE		0x1
170 #define RVG_FUNCT3_BLT		0x4
171 #define RVG_FUNCT3_BGE		0x5
172 #define RVG_FUNCT3_BLTU		0x6
173 #define RVG_FUNCT3_BGEU		0x7
174 
175 /* parts of funct3 code for C extension*/
176 #define RVC_FUNCT3_C_BEQZ	0x6
177 #define RVC_FUNCT3_C_BNEZ	0x7
178 #define RVC_FUNCT3_C_J		0x5
179 #define RVC_FUNCT3_C_JAL	0x1
180 #define RVC_FUNCT4_C_JR		0x8
181 #define RVC_FUNCT4_C_JALR	0x9
182 #define RVC_FUNCT4_C_EBREAK	0x9
183 
184 #define RVG_FUNCT12_EBREAK	0x1
185 #define RVG_FUNCT12_SRET	0x102
186 
187 #define RVG_MATCH_AUIPC		(RVG_OPCODE_AUIPC)
188 #define RVG_MATCH_JALR		(RV_ENCODE_FUNCT3(JALR) | RVG_OPCODE_JALR)
189 #define RVG_MATCH_JAL		(RVG_OPCODE_JAL)
190 #define RVG_MATCH_FENCE		(RVG_OPCODE_FENCE)
191 #define RVG_MATCH_BEQ		(RV_ENCODE_FUNCT3(BEQ) | RVG_OPCODE_BRANCH)
192 #define RVG_MATCH_BNE		(RV_ENCODE_FUNCT3(BNE) | RVG_OPCODE_BRANCH)
193 #define RVG_MATCH_BLT		(RV_ENCODE_FUNCT3(BLT) | RVG_OPCODE_BRANCH)
194 #define RVG_MATCH_BGE		(RV_ENCODE_FUNCT3(BGE) | RVG_OPCODE_BRANCH)
195 #define RVG_MATCH_BLTU		(RV_ENCODE_FUNCT3(BLTU) | RVG_OPCODE_BRANCH)
196 #define RVG_MATCH_BGEU		(RV_ENCODE_FUNCT3(BGEU) | RVG_OPCODE_BRANCH)
197 #define RVG_MATCH_EBREAK	(RV_ENCODE_FUNCT12(EBREAK) | RVG_OPCODE_SYSTEM)
198 #define RVG_MATCH_SRET		(RV_ENCODE_FUNCT12(SRET) | RVG_OPCODE_SYSTEM)
199 #define RVC_MATCH_C_BEQZ	(RVC_ENCODE_FUNCT3(C_BEQZ) | RVC_OPCODE_C1)
200 #define RVC_MATCH_C_BNEZ	(RVC_ENCODE_FUNCT3(C_BNEZ) | RVC_OPCODE_C1)
201 #define RVC_MATCH_C_J		(RVC_ENCODE_FUNCT3(C_J) | RVC_OPCODE_C1)
202 #define RVC_MATCH_C_JAL		(RVC_ENCODE_FUNCT3(C_JAL) | RVC_OPCODE_C1)
203 #define RVC_MATCH_C_JR		(RVC_ENCODE_FUNCT4(C_JR) | RVC_OPCODE_C2)
204 #define RVC_MATCH_C_JALR	(RVC_ENCODE_FUNCT4(C_JALR) | RVC_OPCODE_C2)
205 #define RVC_MATCH_C_EBREAK	(RVC_ENCODE_FUNCT4(C_EBREAK) | RVC_OPCODE_C2)
206 
207 #define RVG_MASK_AUIPC		(RV_INSN_OPCODE_MASK)
208 #define RVG_MASK_JALR		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
209 #define RVG_MASK_JAL		(RV_INSN_OPCODE_MASK)
210 #define RVG_MASK_FENCE		(RV_INSN_OPCODE_MASK)
211 #define RVC_MASK_C_JALR		(RVC_INSN_FUNCT4_MASK | RVC_INSN_J_RS2_MASK | RVC_INSN_OPCODE_MASK)
212 #define RVC_MASK_C_JR		(RVC_INSN_FUNCT4_MASK | RVC_INSN_J_RS2_MASK | RVC_INSN_OPCODE_MASK)
213 #define RVC_MASK_C_JAL		(RVC_INSN_FUNCT3_MASK | RVC_INSN_OPCODE_MASK)
214 #define RVC_MASK_C_J		(RVC_INSN_FUNCT3_MASK | RVC_INSN_OPCODE_MASK)
215 #define RVG_MASK_BEQ		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
216 #define RVG_MASK_BNE		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
217 #define RVG_MASK_BLT		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
218 #define RVG_MASK_BGE		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
219 #define RVG_MASK_BLTU		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
220 #define RVG_MASK_BGEU		(RV_INSN_FUNCT3_MASK | RV_INSN_OPCODE_MASK)
221 #define RVC_MASK_C_BEQZ		(RVC_INSN_FUNCT3_MASK | RVC_INSN_OPCODE_MASK)
222 #define RVC_MASK_C_BNEZ		(RVC_INSN_FUNCT3_MASK | RVC_INSN_OPCODE_MASK)
223 #define RVC_MASK_C_EBREAK	0xffff
224 #define RVG_MASK_EBREAK		0xffffffff
225 #define RVG_MASK_SRET		0xffffffff
226 
227 #define __INSN_LENGTH_MASK	_UL(0x3)
228 #define __INSN_LENGTH_GE_32	_UL(0x3)
229 #define __INSN_OPCODE_MASK	_UL(0x7F)
230 #define __INSN_BRANCH_OPCODE	_UL(RVG_OPCODE_BRANCH)
231 
232 #define __RISCV_INSN_FUNCS(name, mask, val)				\
233 static __always_inline bool riscv_insn_is_##name(u32 code)		\
234 {									\
235 	BUILD_BUG_ON(~(mask) & (val));					\
236 	return (code & (mask)) == (val);				\
237 }									\
238 
239 #if __riscv_xlen == 32
240 /* C.JAL is an RV32C-only instruction */
241 __RISCV_INSN_FUNCS(c_jal, RVC_MASK_C_JAL, RVC_MATCH_C_JAL)
242 #else
243 #define riscv_insn_is_c_jal(opcode) 0
244 #endif
245 __RISCV_INSN_FUNCS(auipc, RVG_MASK_AUIPC, RVG_MATCH_AUIPC)
246 __RISCV_INSN_FUNCS(jalr, RVG_MASK_JALR, RVG_MATCH_JALR)
247 __RISCV_INSN_FUNCS(jal, RVG_MASK_JAL, RVG_MATCH_JAL)
248 __RISCV_INSN_FUNCS(c_jr, RVC_MASK_C_JR, RVC_MATCH_C_JR)
249 __RISCV_INSN_FUNCS(c_jalr, RVC_MASK_C_JALR, RVC_MATCH_C_JALR)
250 __RISCV_INSN_FUNCS(c_j, RVC_MASK_C_J, RVC_MATCH_C_J)
251 __RISCV_INSN_FUNCS(beq, RVG_MASK_BEQ, RVG_MATCH_BEQ)
252 __RISCV_INSN_FUNCS(bne, RVG_MASK_BNE, RVG_MATCH_BNE)
253 __RISCV_INSN_FUNCS(blt, RVG_MASK_BLT, RVG_MATCH_BLT)
254 __RISCV_INSN_FUNCS(bge, RVG_MASK_BGE, RVG_MATCH_BGE)
255 __RISCV_INSN_FUNCS(bltu, RVG_MASK_BLTU, RVG_MATCH_BLTU)
256 __RISCV_INSN_FUNCS(bgeu, RVG_MASK_BGEU, RVG_MATCH_BGEU)
257 __RISCV_INSN_FUNCS(c_beqz, RVC_MASK_C_BEQZ, RVC_MATCH_C_BEQZ)
258 __RISCV_INSN_FUNCS(c_bnez, RVC_MASK_C_BNEZ, RVC_MATCH_C_BNEZ)
259 __RISCV_INSN_FUNCS(c_ebreak, RVC_MASK_C_EBREAK, RVC_MATCH_C_EBREAK)
260 __RISCV_INSN_FUNCS(ebreak, RVG_MASK_EBREAK, RVG_MATCH_EBREAK)
261 __RISCV_INSN_FUNCS(sret, RVG_MASK_SRET, RVG_MATCH_SRET)
262 __RISCV_INSN_FUNCS(fence, RVG_MASK_FENCE, RVG_MATCH_FENCE);
263 
264 /* special case to catch _any_ system instruction */
265 static __always_inline bool riscv_insn_is_system(u32 code)
266 {
267 	return (code & RV_INSN_OPCODE_MASK) == RVG_OPCODE_SYSTEM;
268 }
269 
270 /* special case to catch _any_ branch instruction */
271 static __always_inline bool riscv_insn_is_branch(u32 code)
272 {
273 	return (code & RV_INSN_OPCODE_MASK) == RVG_OPCODE_BRANCH;
274 }
275 
276 #define RV_IMM_SIGN(x) (-(((x) >> 31) & 1))
277 #define RVC_IMM_SIGN(x) (-(((x) >> 12) & 1))
278 #define RV_X(X, s, mask)  (((X) >> (s)) & (mask))
279 #define RVC_X(X, s, mask) RV_X(X, s, mask)
280 
281 #define RV_EXTRACT_RD_REG(x) \
282 	({typeof(x) x_ = (x); \
283 	(RV_X(x_, RVG_RD_OPOFF, RVG_RD_MASK)); })
284 
285 #define RV_EXTRACT_UTYPE_IMM(x) \
286 	({typeof(x) x_ = (x); \
287 	(RV_X(x_, RV_U_IMM_31_12_OPOFF, RV_U_IMM_31_12_MASK)); })
288 
289 #define RV_EXTRACT_JTYPE_IMM(x) \
290 	({typeof(x) x_ = (x); \
291 	(RV_X(x_, RV_J_IMM_10_1_OPOFF, RV_J_IMM_10_1_MASK) << RV_J_IMM_10_1_OFF) | \
292 	(RV_X(x_, RV_J_IMM_11_OPOFF, RV_J_IMM_11_MASK) << RV_J_IMM_11_OFF) | \
293 	(RV_X(x_, RV_J_IMM_19_12_OPOFF, RV_J_IMM_19_12_MASK) << RV_J_IMM_19_12_OFF) | \
294 	(RV_IMM_SIGN(x_) << RV_J_IMM_SIGN_OFF); })
295 
296 #define RV_EXTRACT_ITYPE_IMM(x) \
297 	({typeof(x) x_ = (x); \
298 	(RV_X(x_, RV_I_IMM_11_0_OPOFF, RV_I_IMM_11_0_MASK)) | \
299 	(RV_IMM_SIGN(x_) << RV_I_IMM_SIGN_OFF); })
300 
301 #define RV_EXTRACT_BTYPE_IMM(x) \
302 	({typeof(x) x_ = (x); \
303 	(RV_X(x_, RV_B_IMM_4_1_OPOFF, RV_B_IMM_4_1_MASK) << RV_B_IMM_4_1_OFF) | \
304 	(RV_X(x_, RV_B_IMM_10_5_OPOFF, RV_B_IMM_10_5_MASK) << RV_B_IMM_10_5_OFF) | \
305 	(RV_X(x_, RV_B_IMM_11_OPOFF, RV_B_IMM_11_MASK) << RV_B_IMM_11_OFF) | \
306 	(RV_IMM_SIGN(x_) << RV_B_IMM_SIGN_OFF); })
307 
308 #define RVC_EXTRACT_JTYPE_IMM(x) \
309 	({typeof(x) x_ = (x); \
310 	(RVC_X(x_, RVC_J_IMM_3_1_OPOFF, RVC_J_IMM_3_1_MASK) << RVC_J_IMM_3_1_OFF) | \
311 	(RVC_X(x_, RVC_J_IMM_4_OPOFF, RVC_J_IMM_4_MASK) << RVC_J_IMM_4_OFF) | \
312 	(RVC_X(x_, RVC_J_IMM_5_OPOFF, RVC_J_IMM_5_MASK) << RVC_J_IMM_5_OFF) | \
313 	(RVC_X(x_, RVC_J_IMM_6_OPOFF, RVC_J_IMM_6_MASK) << RVC_J_IMM_6_OFF) | \
314 	(RVC_X(x_, RVC_J_IMM_7_OPOFF, RVC_J_IMM_7_MASK) << RVC_J_IMM_7_OFF) | \
315 	(RVC_X(x_, RVC_J_IMM_9_8_OPOFF, RVC_J_IMM_9_8_MASK) << RVC_J_IMM_9_8_OFF) | \
316 	(RVC_X(x_, RVC_J_IMM_10_OPOFF, RVC_J_IMM_10_MASK) << RVC_J_IMM_10_OFF) | \
317 	(RVC_IMM_SIGN(x_) << RVC_J_IMM_SIGN_OFF); })
318 
319 #define RVC_EXTRACT_BTYPE_IMM(x) \
320 	({typeof(x) x_ = (x); \
321 	(RVC_X(x_, RVC_B_IMM_2_1_OPOFF, RVC_B_IMM_2_1_MASK) << RVC_B_IMM_2_1_OFF) | \
322 	(RVC_X(x_, RVC_B_IMM_4_3_OPOFF, RVC_B_IMM_4_3_MASK) << RVC_B_IMM_4_3_OFF) | \
323 	(RVC_X(x_, RVC_B_IMM_5_OPOFF, RVC_B_IMM_5_MASK) << RVC_B_IMM_5_OFF) | \
324 	(RVC_X(x_, RVC_B_IMM_7_6_OPOFF, RVC_B_IMM_7_6_MASK) << RVC_B_IMM_7_6_OFF) | \
325 	(RVC_IMM_SIGN(x_) << RVC_B_IMM_SIGN_OFF); })
326 
327 #define RVG_EXTRACT_SYSTEM_CSR(x) \
328 	({typeof(x) x_ = (x); RV_X(x_, RVG_SYSTEM_CSR_OFF, RVG_SYSTEM_CSR_MASK); })
329 
330 #define RVFDQ_EXTRACT_FL_FS_WIDTH(x) \
331 	({typeof(x) x_ = (x); RV_X(x_, RVFDQ_FL_FS_WIDTH_OFF, \
332 				   RVFDQ_FL_FS_WIDTH_MASK); })
333 
334 #define RVV_EXRACT_VL_VS_WIDTH(x) RVFDQ_EXTRACT_FL_FS_WIDTH(x)
335 
336 /*
337  * Get the immediate from a J-type instruction.
338  *
339  * @insn: instruction to process
340  * Return: immediate
341  */
342 static inline s32 riscv_insn_extract_jtype_imm(u32 insn)
343 {
344 	return RV_EXTRACT_JTYPE_IMM(insn);
345 }
346 
347 /*
348  * Update a J-type instruction with an immediate value.
349  *
350  * @insn: pointer to the jtype instruction
351  * @imm: the immediate to insert into the instruction
352  */
353 static inline void riscv_insn_insert_jtype_imm(u32 *insn, s32 imm)
354 {
355 	/* drop the old IMMs, all jal IMM bits sit at 31:12 */
356 	*insn &= ~GENMASK(31, 12);
357 	*insn |= (RV_X(imm, RV_J_IMM_10_1_OFF, RV_J_IMM_10_1_MASK) << RV_J_IMM_10_1_OPOFF) |
358 		 (RV_X(imm, RV_J_IMM_11_OFF, RV_J_IMM_11_MASK) << RV_J_IMM_11_OPOFF) |
359 		 (RV_X(imm, RV_J_IMM_19_12_OFF, RV_J_IMM_19_12_MASK) << RV_J_IMM_19_12_OPOFF) |
360 		 (RV_X(imm, RV_J_IMM_SIGN_OFF, 1) << RV_J_IMM_SIGN_OPOFF);
361 }
362 
363 /*
364  * Put together one immediate from a U-type and I-type instruction pair.
365  *
366  * The U-type contains an upper immediate, meaning bits[31:12] with [11:0]
367  * being zero, while the I-type contains a 12bit immediate.
368  * Combined these can encode larger 32bit values and are used for example
369  * in auipc + jalr pairs to allow larger jumps.
370  *
371  * @utype_insn: instruction containing the upper immediate
372  * @itype_insn: instruction
373  * Return: combined immediate
374  */
375 static inline s32 riscv_insn_extract_utype_itype_imm(u32 utype_insn, u32 itype_insn)
376 {
377 	s32 imm;
378 
379 	imm = RV_EXTRACT_UTYPE_IMM(utype_insn);
380 	imm += RV_EXTRACT_ITYPE_IMM(itype_insn);
381 
382 	return imm;
383 }
384 
385 /*
386  * Update a set of two instructions (U-type + I-type) with an immediate value.
387  *
388  * Used for example in auipc+jalrs pairs the U-type instructions contains
389  * a 20bit upper immediate representing bits[31:12], while the I-type
390  * instruction contains a 12bit immediate representing bits[11:0].
391  *
392  * This also takes into account that both separate immediates are
393  * considered as signed values, so if the I-type immediate becomes
394  * negative (BIT(11) set) the U-type part gets adjusted.
395  *
396  * @utype_insn: pointer to the utype instruction of the pair
397  * @itype_insn: pointer to the itype instruction of the pair
398  * @imm: the immediate to insert into the two instructions
399  */
400 static inline void riscv_insn_insert_utype_itype_imm(u32 *utype_insn, u32 *itype_insn, s32 imm)
401 {
402 	/* drop possible old IMM values */
403 	*utype_insn &= ~(RV_U_IMM_31_12_MASK);
404 	*itype_insn &= ~(RV_I_IMM_11_0_MASK << RV_I_IMM_11_0_OPOFF);
405 
406 	/* add the adapted IMMs */
407 	*utype_insn |= (imm & RV_U_IMM_31_12_MASK) + ((imm & BIT(11)) << 1);
408 	*itype_insn |= ((imm & RV_I_IMM_11_0_MASK) << RV_I_IMM_11_0_OPOFF);
409 }
410 #endif /* _ASM_RISCV_INSN_H */
411