xref: /linux/arch/arm64/include/asm/insn.h (revision 570f7e331f5febb30f1384817463c7e42b65ca7d)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2013 Huawei Ltd.
4  * Author: Jiang Liu <liuj97@gmail.com>
5  *
6  * Copyright (C) 2014 Zi Shen Lim <zlim.lnx@gmail.com>
7  */
8 #ifndef	__ASM_INSN_H
9 #define	__ASM_INSN_H
10 #include <linux/build_bug.h>
11 #include <linux/types.h>
12 
13 #include <asm/insn-def.h>
14 
15 #ifndef __ASSEMBLER__
16 
17 enum aarch64_insn_hint_cr_op {
18 	AARCH64_INSN_HINT_NOP	= 0x0 << 5,
19 	AARCH64_INSN_HINT_YIELD	= 0x1 << 5,
20 	AARCH64_INSN_HINT_WFE	= 0x2 << 5,
21 	AARCH64_INSN_HINT_WFI	= 0x3 << 5,
22 	AARCH64_INSN_HINT_SEV	= 0x4 << 5,
23 	AARCH64_INSN_HINT_SEVL	= 0x5 << 5,
24 
25 	AARCH64_INSN_HINT_XPACLRI    = 0x07 << 5,
26 	AARCH64_INSN_HINT_PACIA_1716 = 0x08 << 5,
27 	AARCH64_INSN_HINT_PACIB_1716 = 0x0A << 5,
28 	AARCH64_INSN_HINT_AUTIA_1716 = 0x0C << 5,
29 	AARCH64_INSN_HINT_AUTIB_1716 = 0x0E << 5,
30 	AARCH64_INSN_HINT_PACIAZ     = 0x18 << 5,
31 	AARCH64_INSN_HINT_PACIASP    = 0x19 << 5,
32 	AARCH64_INSN_HINT_PACIBZ     = 0x1A << 5,
33 	AARCH64_INSN_HINT_PACIBSP    = 0x1B << 5,
34 	AARCH64_INSN_HINT_AUTIAZ     = 0x1C << 5,
35 	AARCH64_INSN_HINT_AUTIASP    = 0x1D << 5,
36 	AARCH64_INSN_HINT_AUTIBZ     = 0x1E << 5,
37 	AARCH64_INSN_HINT_AUTIBSP    = 0x1F << 5,
38 
39 	AARCH64_INSN_HINT_ESB  = 0x10 << 5,
40 	AARCH64_INSN_HINT_PSB  = 0x11 << 5,
41 	AARCH64_INSN_HINT_TSB  = 0x12 << 5,
42 	AARCH64_INSN_HINT_CSDB = 0x14 << 5,
43 	AARCH64_INSN_HINT_CLEARBHB = 0x16 << 5,
44 
45 	AARCH64_INSN_HINT_BTI   = 0x20 << 5,
46 	AARCH64_INSN_HINT_BTIC  = 0x22 << 5,
47 	AARCH64_INSN_HINT_BTIJ  = 0x24 << 5,
48 	AARCH64_INSN_HINT_BTIJC = 0x26 << 5,
49 };
50 
51 enum aarch64_insn_imm_type {
52 	AARCH64_INSN_IMM_ADR,
53 	AARCH64_INSN_IMM_26,
54 	AARCH64_INSN_IMM_19,
55 	AARCH64_INSN_IMM_16,
56 	AARCH64_INSN_IMM_14,
57 	AARCH64_INSN_IMM_12,
58 	AARCH64_INSN_IMM_9,
59 	AARCH64_INSN_IMM_7,
60 	AARCH64_INSN_IMM_6,
61 	AARCH64_INSN_IMM_S,
62 	AARCH64_INSN_IMM_R,
63 	AARCH64_INSN_IMM_N,
64 	AARCH64_INSN_IMM_MAX
65 };
66 
67 enum aarch64_insn_register_type {
68 	AARCH64_INSN_REGTYPE_RT,
69 	AARCH64_INSN_REGTYPE_RN,
70 	AARCH64_INSN_REGTYPE_RT2,
71 	AARCH64_INSN_REGTYPE_RM,
72 	AARCH64_INSN_REGTYPE_RD,
73 	AARCH64_INSN_REGTYPE_RA,
74 	AARCH64_INSN_REGTYPE_RS,
75 };
76 
77 enum aarch64_insn_register {
78 	AARCH64_INSN_REG_0  = 0,
79 	AARCH64_INSN_REG_1  = 1,
80 	AARCH64_INSN_REG_2  = 2,
81 	AARCH64_INSN_REG_3  = 3,
82 	AARCH64_INSN_REG_4  = 4,
83 	AARCH64_INSN_REG_5  = 5,
84 	AARCH64_INSN_REG_6  = 6,
85 	AARCH64_INSN_REG_7  = 7,
86 	AARCH64_INSN_REG_8  = 8,
87 	AARCH64_INSN_REG_9  = 9,
88 	AARCH64_INSN_REG_10 = 10,
89 	AARCH64_INSN_REG_11 = 11,
90 	AARCH64_INSN_REG_12 = 12,
91 	AARCH64_INSN_REG_13 = 13,
92 	AARCH64_INSN_REG_14 = 14,
93 	AARCH64_INSN_REG_15 = 15,
94 	AARCH64_INSN_REG_16 = 16,
95 	AARCH64_INSN_REG_17 = 17,
96 	AARCH64_INSN_REG_18 = 18,
97 	AARCH64_INSN_REG_19 = 19,
98 	AARCH64_INSN_REG_20 = 20,
99 	AARCH64_INSN_REG_21 = 21,
100 	AARCH64_INSN_REG_22 = 22,
101 	AARCH64_INSN_REG_23 = 23,
102 	AARCH64_INSN_REG_24 = 24,
103 	AARCH64_INSN_REG_25 = 25,
104 	AARCH64_INSN_REG_26 = 26,
105 	AARCH64_INSN_REG_27 = 27,
106 	AARCH64_INSN_REG_28 = 28,
107 	AARCH64_INSN_REG_29 = 29,
108 	AARCH64_INSN_REG_FP = 29, /* Frame pointer */
109 	AARCH64_INSN_REG_30 = 30,
110 	AARCH64_INSN_REG_LR = 30, /* Link register */
111 	AARCH64_INSN_REG_ZR = 31, /* Zero: as source register */
112 	AARCH64_INSN_REG_SP = 31  /* Stack pointer: as load/store base reg */
113 };
114 
115 enum aarch64_insn_special_register {
116 	AARCH64_INSN_SPCLREG_SPSR_EL1	= 0xC200,
117 	AARCH64_INSN_SPCLREG_ELR_EL1	= 0xC201,
118 	AARCH64_INSN_SPCLREG_SP_EL0	= 0xC208,
119 	AARCH64_INSN_SPCLREG_SPSEL	= 0xC210,
120 	AARCH64_INSN_SPCLREG_CURRENTEL	= 0xC212,
121 	AARCH64_INSN_SPCLREG_DAIF	= 0xDA11,
122 	AARCH64_INSN_SPCLREG_NZCV	= 0xDA10,
123 	AARCH64_INSN_SPCLREG_FPCR	= 0xDA20,
124 	AARCH64_INSN_SPCLREG_DSPSR_EL0	= 0xDA28,
125 	AARCH64_INSN_SPCLREG_DLR_EL0	= 0xDA29,
126 	AARCH64_INSN_SPCLREG_SPSR_EL2	= 0xE200,
127 	AARCH64_INSN_SPCLREG_ELR_EL2	= 0xE201,
128 	AARCH64_INSN_SPCLREG_SP_EL1	= 0xE208,
129 	AARCH64_INSN_SPCLREG_SPSR_INQ	= 0xE218,
130 	AARCH64_INSN_SPCLREG_SPSR_ABT	= 0xE219,
131 	AARCH64_INSN_SPCLREG_SPSR_UND	= 0xE21A,
132 	AARCH64_INSN_SPCLREG_SPSR_FIQ	= 0xE21B,
133 	AARCH64_INSN_SPCLREG_SPSR_EL3	= 0xF200,
134 	AARCH64_INSN_SPCLREG_ELR_EL3	= 0xF201,
135 	AARCH64_INSN_SPCLREG_SP_EL2	= 0xF210
136 };
137 
138 enum aarch64_insn_system_register {
139 	AARCH64_INSN_SYSREG_TPIDR_EL1	= 0x4684,
140 	AARCH64_INSN_SYSREG_TPIDR_EL2	= 0x6682,
141 	AARCH64_INSN_SYSREG_SP_EL0	= 0x4208,
142 };
143 
144 enum aarch64_insn_variant {
145 	AARCH64_INSN_VARIANT_32BIT,
146 	AARCH64_INSN_VARIANT_64BIT
147 };
148 
149 enum aarch64_insn_condition {
150 	AARCH64_INSN_COND_EQ = 0x0, /* == */
151 	AARCH64_INSN_COND_NE = 0x1, /* != */
152 	AARCH64_INSN_COND_CS = 0x2, /* unsigned >= */
153 	AARCH64_INSN_COND_CC = 0x3, /* unsigned < */
154 	AARCH64_INSN_COND_MI = 0x4, /* < 0 */
155 	AARCH64_INSN_COND_PL = 0x5, /* >= 0 */
156 	AARCH64_INSN_COND_VS = 0x6, /* overflow */
157 	AARCH64_INSN_COND_VC = 0x7, /* no overflow */
158 	AARCH64_INSN_COND_HI = 0x8, /* unsigned > */
159 	AARCH64_INSN_COND_LS = 0x9, /* unsigned <= */
160 	AARCH64_INSN_COND_GE = 0xa, /* signed >= */
161 	AARCH64_INSN_COND_LT = 0xb, /* signed < */
162 	AARCH64_INSN_COND_GT = 0xc, /* signed > */
163 	AARCH64_INSN_COND_LE = 0xd, /* signed <= */
164 	AARCH64_INSN_COND_AL = 0xe, /* always */
165 };
166 
167 enum aarch64_insn_branch_type {
168 	AARCH64_INSN_BRANCH_NOLINK,
169 	AARCH64_INSN_BRANCH_LINK,
170 	AARCH64_INSN_BRANCH_RETURN,
171 	AARCH64_INSN_BRANCH_COMP_ZERO,
172 	AARCH64_INSN_BRANCH_COMP_NONZERO,
173 };
174 
175 enum aarch64_insn_size_type {
176 	AARCH64_INSN_SIZE_8,
177 	AARCH64_INSN_SIZE_16,
178 	AARCH64_INSN_SIZE_32,
179 	AARCH64_INSN_SIZE_64,
180 };
181 
182 enum aarch64_insn_ldst_type {
183 	AARCH64_INSN_LDST_LOAD_REG_OFFSET,
184 	AARCH64_INSN_LDST_STORE_REG_OFFSET,
185 	AARCH64_INSN_LDST_LOAD_IMM_OFFSET,
186 	AARCH64_INSN_LDST_STORE_IMM_OFFSET,
187 	AARCH64_INSN_LDST_LOAD_PAIR_PRE_INDEX,
188 	AARCH64_INSN_LDST_STORE_PAIR_PRE_INDEX,
189 	AARCH64_INSN_LDST_LOAD_PAIR_POST_INDEX,
190 	AARCH64_INSN_LDST_STORE_PAIR_POST_INDEX,
191 	AARCH64_INSN_LDST_LOAD_ACQ,
192 	AARCH64_INSN_LDST_LOAD_EX,
193 	AARCH64_INSN_LDST_LOAD_ACQ_EX,
194 	AARCH64_INSN_LDST_STORE_REL,
195 	AARCH64_INSN_LDST_STORE_EX,
196 	AARCH64_INSN_LDST_STORE_REL_EX,
197 	AARCH64_INSN_LDST_SIGNED_LOAD_IMM_OFFSET,
198 	AARCH64_INSN_LDST_SIGNED_LOAD_REG_OFFSET,
199 };
200 
201 enum aarch64_insn_adsb_type {
202 	AARCH64_INSN_ADSB_ADD,
203 	AARCH64_INSN_ADSB_SUB,
204 	AARCH64_INSN_ADSB_ADD_SETFLAGS,
205 	AARCH64_INSN_ADSB_SUB_SETFLAGS
206 };
207 
208 /* option field of add/sub (extended register) */
209 enum aarch64_insn_extend_type {
210 	AARCH64_INSN_EXTEND_UXTB,
211 	AARCH64_INSN_EXTEND_UXTH,
212 	AARCH64_INSN_EXTEND_UXTW,
213 	AARCH64_INSN_EXTEND_UXTX,
214 	AARCH64_INSN_EXTEND_SXTB,
215 	AARCH64_INSN_EXTEND_SXTH,
216 	AARCH64_INSN_EXTEND_SXTW,
217 	AARCH64_INSN_EXTEND_SXTX,
218 };
219 
220 enum aarch64_insn_movewide_type {
221 	AARCH64_INSN_MOVEWIDE_ZERO,
222 	AARCH64_INSN_MOVEWIDE_KEEP,
223 	AARCH64_INSN_MOVEWIDE_INVERSE
224 };
225 
226 enum aarch64_insn_bitfield_type {
227 	AARCH64_INSN_BITFIELD_MOVE,
228 	AARCH64_INSN_BITFIELD_MOVE_UNSIGNED,
229 	AARCH64_INSN_BITFIELD_MOVE_SIGNED
230 };
231 
232 enum aarch64_insn_data1_type {
233 	AARCH64_INSN_DATA1_REVERSE_16,
234 	AARCH64_INSN_DATA1_REVERSE_32,
235 	AARCH64_INSN_DATA1_REVERSE_64,
236 };
237 
238 enum aarch64_insn_data2_type {
239 	AARCH64_INSN_DATA2_UDIV,
240 	AARCH64_INSN_DATA2_SDIV,
241 	AARCH64_INSN_DATA2_LSLV,
242 	AARCH64_INSN_DATA2_LSRV,
243 	AARCH64_INSN_DATA2_ASRV,
244 	AARCH64_INSN_DATA2_RORV,
245 };
246 
247 enum aarch64_insn_data3_type {
248 	AARCH64_INSN_DATA3_MADD,
249 	AARCH64_INSN_DATA3_MSUB,
250 };
251 
252 enum aarch64_insn_logic_type {
253 	AARCH64_INSN_LOGIC_AND,
254 	AARCH64_INSN_LOGIC_BIC,
255 	AARCH64_INSN_LOGIC_ORR,
256 	AARCH64_INSN_LOGIC_ORN,
257 	AARCH64_INSN_LOGIC_EOR,
258 	AARCH64_INSN_LOGIC_EON,
259 	AARCH64_INSN_LOGIC_AND_SETFLAGS,
260 	AARCH64_INSN_LOGIC_BIC_SETFLAGS
261 };
262 
263 enum aarch64_insn_prfm_type {
264 	AARCH64_INSN_PRFM_TYPE_PLD,
265 	AARCH64_INSN_PRFM_TYPE_PLI,
266 	AARCH64_INSN_PRFM_TYPE_PST,
267 };
268 
269 enum aarch64_insn_prfm_target {
270 	AARCH64_INSN_PRFM_TARGET_L1,
271 	AARCH64_INSN_PRFM_TARGET_L2,
272 	AARCH64_INSN_PRFM_TARGET_L3,
273 };
274 
275 enum aarch64_insn_prfm_policy {
276 	AARCH64_INSN_PRFM_POLICY_KEEP,
277 	AARCH64_INSN_PRFM_POLICY_STRM,
278 };
279 
280 enum aarch64_insn_adr_type {
281 	AARCH64_INSN_ADR_TYPE_ADRP,
282 	AARCH64_INSN_ADR_TYPE_ADR,
283 };
284 
285 enum aarch64_insn_mem_atomic_op {
286 	AARCH64_INSN_MEM_ATOMIC_ADD,
287 	AARCH64_INSN_MEM_ATOMIC_CLR,
288 	AARCH64_INSN_MEM_ATOMIC_EOR,
289 	AARCH64_INSN_MEM_ATOMIC_SET,
290 	AARCH64_INSN_MEM_ATOMIC_SWP,
291 };
292 
293 enum aarch64_insn_mem_order_type {
294 	AARCH64_INSN_MEM_ORDER_NONE,
295 	AARCH64_INSN_MEM_ORDER_ACQ,
296 	AARCH64_INSN_MEM_ORDER_REL,
297 	AARCH64_INSN_MEM_ORDER_ACQREL,
298 };
299 
300 enum aarch64_insn_mb_type {
301 	AARCH64_INSN_MB_SY,
302 	AARCH64_INSN_MB_ST,
303 	AARCH64_INSN_MB_LD,
304 	AARCH64_INSN_MB_ISH,
305 	AARCH64_INSN_MB_ISHST,
306 	AARCH64_INSN_MB_ISHLD,
307 	AARCH64_INSN_MB_NSH,
308 	AARCH64_INSN_MB_NSHST,
309 	AARCH64_INSN_MB_NSHLD,
310 	AARCH64_INSN_MB_OSH,
311 	AARCH64_INSN_MB_OSHST,
312 	AARCH64_INSN_MB_OSHLD,
313 };
314 
315 #define	__AARCH64_INSN_FUNCS(abbr, mask, val)				\
316 static __always_inline bool aarch64_insn_is_##abbr(u32 code)		\
317 {									\
318 	BUILD_BUG_ON(~(mask) & (val));					\
319 	return (code & (mask)) == (val);				\
320 }									\
321 static __always_inline u32 aarch64_insn_get_##abbr##_value(void)	\
322 {									\
323 	return (val);							\
324 }
325 
326 /*
327  * ARM Architecture Reference Manual for ARMv8 Profile-A, Issue A.a
328  * Section C3.1 "A64 instruction index by encoding":
329  * AArch64 main encoding table
330  *  Bit position
331  *   28 27 26 25	Encoding Group
332  *   0  0  -  -		Unallocated
333  *   1  0  0  -		Data processing, immediate
334  *   1  0  1  -		Branch, exception generation and system instructions
335  *   -  1  -  0		Loads and stores
336  *   -  1  0  1		Data processing - register
337  *   0  1  1  1		Data processing - SIMD and floating point
338  *   1  1  1  1		Data processing - SIMD and floating point
339  * "-" means "don't care"
340  */
341 __AARCH64_INSN_FUNCS(class_branch_sys,	0x1c000000, 0x14000000)
342 
343 __AARCH64_INSN_FUNCS(adr,	0x9F000000, 0x10000000)
344 __AARCH64_INSN_FUNCS(adrp,	0x9F000000, 0x90000000)
345 __AARCH64_INSN_FUNCS(prfm,	0x3FC00000, 0x39800000)
346 __AARCH64_INSN_FUNCS(prfm_lit,	0xFF000000, 0xD8000000)
347 __AARCH64_INSN_FUNCS(store_imm,	0x3FC00000, 0x39000000)
348 __AARCH64_INSN_FUNCS(load_imm,	0x3FC00000, 0x39400000)
349 __AARCH64_INSN_FUNCS(signed_load_imm, 0X3FC00000, 0x39800000)
350 __AARCH64_INSN_FUNCS(store_pre,	0x3FE00C00, 0x38000C00)
351 __AARCH64_INSN_FUNCS(load_pre,	0x3FE00C00, 0x38400C00)
352 __AARCH64_INSN_FUNCS(store_post,	0x3FE00C00, 0x38000400)
353 __AARCH64_INSN_FUNCS(load_post,	0x3FE00C00, 0x38400400)
354 __AARCH64_INSN_FUNCS(str_reg,	0x3FE0EC00, 0x38206800)
355 __AARCH64_INSN_FUNCS(str_imm,	0x3FC00000, 0x39000000)
356 __AARCH64_INSN_FUNCS(ldadd,	0x3F20FC00, 0x38200000)
357 __AARCH64_INSN_FUNCS(ldclr,	0x3F20FC00, 0x38201000)
358 __AARCH64_INSN_FUNCS(ldeor,	0x3F20FC00, 0x38202000)
359 __AARCH64_INSN_FUNCS(ldset,	0x3F20FC00, 0x38203000)
360 __AARCH64_INSN_FUNCS(swp,	0x3F20FC00, 0x38208000)
361 __AARCH64_INSN_FUNCS(cas,	0x3FA07C00, 0x08A07C00)
362 __AARCH64_INSN_FUNCS(ldr_reg,	0x3FE0EC00, 0x38606800)
363 __AARCH64_INSN_FUNCS(signed_ldr_reg, 0X3FE0FC00, 0x38A0E800)
364 __AARCH64_INSN_FUNCS(ldr_imm,	0x3FC00000, 0x39400000)
365 __AARCH64_INSN_FUNCS(ldr_lit,	0xBF000000, 0x18000000)
366 __AARCH64_INSN_FUNCS(ldrsw_lit,	0xFF000000, 0x98000000)
367 __AARCH64_INSN_FUNCS(exclusive,	0x3F800000, 0x08000000)
368 __AARCH64_INSN_FUNCS(load_acq,  0x3FDFFC00, 0x08DFFC00)
369 __AARCH64_INSN_FUNCS(store_rel, 0x3FDFFC00, 0x089FFC00)
370 __AARCH64_INSN_FUNCS(load_ex,	0x3FC00000, 0x08400000)
371 __AARCH64_INSN_FUNCS(store_ex,	0x3FC00000, 0x08000000)
372 __AARCH64_INSN_FUNCS(mops,	0x3B200C00, 0x19000400)
373 __AARCH64_INSN_FUNCS(stp,	0x7FC00000, 0x29000000)
374 __AARCH64_INSN_FUNCS(ldp,	0x7FC00000, 0x29400000)
375 __AARCH64_INSN_FUNCS(stp_post,	0x7FC00000, 0x28800000)
376 __AARCH64_INSN_FUNCS(ldp_post,	0x7FC00000, 0x28C00000)
377 __AARCH64_INSN_FUNCS(stp_pre,	0x7FC00000, 0x29800000)
378 __AARCH64_INSN_FUNCS(ldp_pre,	0x7FC00000, 0x29C00000)
379 __AARCH64_INSN_FUNCS(add_imm,	0x7F000000, 0x11000000)
380 __AARCH64_INSN_FUNCS(adds_imm,	0x7F000000, 0x31000000)
381 __AARCH64_INSN_FUNCS(sub_imm,	0x7F000000, 0x51000000)
382 __AARCH64_INSN_FUNCS(subs_imm,	0x7F000000, 0x71000000)
383 __AARCH64_INSN_FUNCS(movn,	0x7F800000, 0x12800000)
384 __AARCH64_INSN_FUNCS(sbfm,	0x7F800000, 0x13000000)
385 __AARCH64_INSN_FUNCS(bfm,	0x7F800000, 0x33000000)
386 __AARCH64_INSN_FUNCS(movz,	0x7F800000, 0x52800000)
387 __AARCH64_INSN_FUNCS(ubfm,	0x7F800000, 0x53000000)
388 __AARCH64_INSN_FUNCS(movk,	0x7F800000, 0x72800000)
389 __AARCH64_INSN_FUNCS(add,	0x7F200000, 0x0B000000)
390 __AARCH64_INSN_FUNCS(adds,	0x7F200000, 0x2B000000)
391 __AARCH64_INSN_FUNCS(sub,	0x7F200000, 0x4B000000)
392 __AARCH64_INSN_FUNCS(subs,	0x7F200000, 0x6B000000)
393 __AARCH64_INSN_FUNCS(add_ext,	0x7FE00000, 0x0B200000)
394 __AARCH64_INSN_FUNCS(adds_ext,	0x7FE00000, 0x2B200000)
395 __AARCH64_INSN_FUNCS(sub_ext,	0x7FE00000, 0x4B200000)
396 __AARCH64_INSN_FUNCS(subs_ext,	0x7FE00000, 0x6B200000)
397 __AARCH64_INSN_FUNCS(madd,	0x7FE08000, 0x1B000000)
398 __AARCH64_INSN_FUNCS(msub,	0x7FE08000, 0x1B008000)
399 __AARCH64_INSN_FUNCS(udiv,	0x7FE0FC00, 0x1AC00800)
400 __AARCH64_INSN_FUNCS(sdiv,	0x7FE0FC00, 0x1AC00C00)
401 __AARCH64_INSN_FUNCS(lslv,	0x7FE0FC00, 0x1AC02000)
402 __AARCH64_INSN_FUNCS(lsrv,	0x7FE0FC00, 0x1AC02400)
403 __AARCH64_INSN_FUNCS(asrv,	0x7FE0FC00, 0x1AC02800)
404 __AARCH64_INSN_FUNCS(rorv,	0x7FE0FC00, 0x1AC02C00)
405 __AARCH64_INSN_FUNCS(rev16,	0x7FFFFC00, 0x5AC00400)
406 __AARCH64_INSN_FUNCS(rev32,	0x7FFFFC00, 0x5AC00800)
407 __AARCH64_INSN_FUNCS(rev64,	0x7FFFFC00, 0x5AC00C00)
408 __AARCH64_INSN_FUNCS(and,	0x7F200000, 0x0A000000)
409 __AARCH64_INSN_FUNCS(bic,	0x7F200000, 0x0A200000)
410 __AARCH64_INSN_FUNCS(orr,	0x7F200000, 0x2A000000)
411 __AARCH64_INSN_FUNCS(mov_reg,	0x7FE0FFE0, 0x2A0003E0)
412 __AARCH64_INSN_FUNCS(orn,	0x7F200000, 0x2A200000)
413 __AARCH64_INSN_FUNCS(eor,	0x7F200000, 0x4A000000)
414 __AARCH64_INSN_FUNCS(eon,	0x7F200000, 0x4A200000)
415 __AARCH64_INSN_FUNCS(ands,	0x7F200000, 0x6A000000)
416 __AARCH64_INSN_FUNCS(bics,	0x7F200000, 0x6A200000)
417 __AARCH64_INSN_FUNCS(and_imm,	0x7F800000, 0x12000000)
418 __AARCH64_INSN_FUNCS(orr_imm,	0x7F800000, 0x32000000)
419 __AARCH64_INSN_FUNCS(eor_imm,	0x7F800000, 0x52000000)
420 __AARCH64_INSN_FUNCS(ands_imm,	0x7F800000, 0x72000000)
421 __AARCH64_INSN_FUNCS(extr,	0x7FA00000, 0x13800000)
422 __AARCH64_INSN_FUNCS(b,		0xFC000000, 0x14000000)
423 __AARCH64_INSN_FUNCS(bl,	0xFC000000, 0x94000000)
424 __AARCH64_INSN_FUNCS(cbz,	0x7F000000, 0x34000000)
425 __AARCH64_INSN_FUNCS(cbnz,	0x7F000000, 0x35000000)
426 __AARCH64_INSN_FUNCS(tbz,	0x7F000000, 0x36000000)
427 __AARCH64_INSN_FUNCS(tbnz,	0x7F000000, 0x37000000)
428 __AARCH64_INSN_FUNCS(bcond,	0xFF000000, 0x54000000)
429 __AARCH64_INSN_FUNCS(svc,	0xFFE0001F, 0xD4000001)
430 __AARCH64_INSN_FUNCS(hvc,	0xFFE0001F, 0xD4000002)
431 __AARCH64_INSN_FUNCS(smc,	0xFFE0001F, 0xD4000003)
432 __AARCH64_INSN_FUNCS(brk,	0xFFE0001F, 0xD4200000)
433 __AARCH64_INSN_FUNCS(exception,	0xFF000000, 0xD4000000)
434 __AARCH64_INSN_FUNCS(hint,	0xFFFFF01F, 0xD503201F)
435 __AARCH64_INSN_FUNCS(br,	0xFFFFFC1F, 0xD61F0000)
436 __AARCH64_INSN_FUNCS(br_auth,	0xFEFFF800, 0xD61F0800)
437 __AARCH64_INSN_FUNCS(blr,	0xFFFFFC1F, 0xD63F0000)
438 __AARCH64_INSN_FUNCS(blr_auth,	0xFEFFF800, 0xD63F0800)
439 __AARCH64_INSN_FUNCS(ret,	0xFFFFFC1F, 0xD65F0000)
440 __AARCH64_INSN_FUNCS(ret_auth,	0xFFFFFBFF, 0xD65F0BFF)
441 __AARCH64_INSN_FUNCS(eret,	0xFFFFFFFF, 0xD69F03E0)
442 __AARCH64_INSN_FUNCS(eret_auth,	0xFFFFFBFF, 0xD69F0BFF)
443 __AARCH64_INSN_FUNCS(mrs,	0xFFF00000, 0xD5300000)
444 __AARCH64_INSN_FUNCS(msr_imm,	0xFFF8F01F, 0xD500401F)
445 __AARCH64_INSN_FUNCS(msr_reg,	0xFFF00000, 0xD5100000)
446 __AARCH64_INSN_FUNCS(dmb,	0xFFFFF0FF, 0xD50330BF)
447 __AARCH64_INSN_FUNCS(dsb_base,	0xFFFFF0FF, 0xD503309F)
448 __AARCH64_INSN_FUNCS(dsb_nxs,	0xFFFFF3FF, 0xD503323F)
449 __AARCH64_INSN_FUNCS(isb,	0xFFFFF0FF, 0xD50330DF)
450 __AARCH64_INSN_FUNCS(sb,	0xFFFFFFFF, 0xD50330FF)
451 __AARCH64_INSN_FUNCS(clrex,	0xFFFFF0FF, 0xD503305F)
452 __AARCH64_INSN_FUNCS(ssbb,	0xFFFFFFFF, 0xD503309F)
453 __AARCH64_INSN_FUNCS(pssbb,	0xFFFFFFFF, 0xD503349F)
454 __AARCH64_INSN_FUNCS(bti,	0xFFFFFF3F, 0xD503241f)
455 
456 #undef	__AARCH64_INSN_FUNCS
457 
458 static __always_inline bool aarch64_insn_is_steppable_hint(u32 insn)
459 {
460 	if (!aarch64_insn_is_hint(insn))
461 		return false;
462 
463 	switch (insn & 0xFE0) {
464 	case AARCH64_INSN_HINT_XPACLRI:
465 	case AARCH64_INSN_HINT_PACIA_1716:
466 	case AARCH64_INSN_HINT_PACIB_1716:
467 	case AARCH64_INSN_HINT_PACIAZ:
468 	case AARCH64_INSN_HINT_PACIASP:
469 	case AARCH64_INSN_HINT_PACIBZ:
470 	case AARCH64_INSN_HINT_PACIBSP:
471 	case AARCH64_INSN_HINT_BTI:
472 	case AARCH64_INSN_HINT_BTIC:
473 	case AARCH64_INSN_HINT_BTIJ:
474 	case AARCH64_INSN_HINT_BTIJC:
475 	case AARCH64_INSN_HINT_NOP:
476 		return true;
477 	default:
478 		return false;
479 	}
480 }
481 
482 static __always_inline bool aarch64_insn_is_branch(u32 insn)
483 {
484 	/* b, bl, cb*, tb*, ret*, b.cond, br*, blr* */
485 
486 	return aarch64_insn_is_b(insn) ||
487 	       aarch64_insn_is_bl(insn) ||
488 	       aarch64_insn_is_cbz(insn) ||
489 	       aarch64_insn_is_cbnz(insn) ||
490 	       aarch64_insn_is_tbz(insn) ||
491 	       aarch64_insn_is_tbnz(insn) ||
492 	       aarch64_insn_is_ret(insn) ||
493 	       aarch64_insn_is_ret_auth(insn) ||
494 	       aarch64_insn_is_br(insn) ||
495 	       aarch64_insn_is_br_auth(insn) ||
496 	       aarch64_insn_is_blr(insn) ||
497 	       aarch64_insn_is_blr_auth(insn) ||
498 	       aarch64_insn_is_bcond(insn);
499 }
500 
501 static __always_inline bool aarch64_insn_is_branch_imm(u32 insn)
502 {
503 	return aarch64_insn_is_b(insn) ||
504 	       aarch64_insn_is_bl(insn) ||
505 	       aarch64_insn_is_tbz(insn) ||
506 	       aarch64_insn_is_tbnz(insn) ||
507 	       aarch64_insn_is_cbz(insn) ||
508 	       aarch64_insn_is_cbnz(insn) ||
509 	       aarch64_insn_is_bcond(insn);
510 }
511 
512 static __always_inline bool aarch64_insn_is_adr_adrp(u32 insn)
513 {
514 	return aarch64_insn_is_adr(insn) ||
515 	       aarch64_insn_is_adrp(insn);
516 }
517 
518 static __always_inline bool aarch64_insn_is_dsb(u32 insn)
519 {
520 	return aarch64_insn_is_dsb_base(insn) ||
521 	       aarch64_insn_is_dsb_nxs(insn);
522 }
523 
524 static __always_inline bool aarch64_insn_is_barrier(u32 insn)
525 {
526 	return aarch64_insn_is_dmb(insn) ||
527 	       aarch64_insn_is_dsb(insn) ||
528 	       aarch64_insn_is_isb(insn) ||
529 	       aarch64_insn_is_sb(insn) ||
530 	       aarch64_insn_is_clrex(insn) ||
531 	       aarch64_insn_is_ssbb(insn) ||
532 	       aarch64_insn_is_pssbb(insn);
533 }
534 
535 static __always_inline bool aarch64_insn_is_store_single(u32 insn)
536 {
537 	return aarch64_insn_is_store_imm(insn) ||
538 	       aarch64_insn_is_store_pre(insn) ||
539 	       aarch64_insn_is_store_post(insn);
540 }
541 
542 static __always_inline bool aarch64_insn_is_store_pair(u32 insn)
543 {
544 	return aarch64_insn_is_stp(insn) ||
545 	       aarch64_insn_is_stp_pre(insn) ||
546 	       aarch64_insn_is_stp_post(insn);
547 }
548 
549 static __always_inline bool aarch64_insn_is_load_single(u32 insn)
550 {
551 	return aarch64_insn_is_load_imm(insn) ||
552 	       aarch64_insn_is_load_pre(insn) ||
553 	       aarch64_insn_is_load_post(insn);
554 }
555 
556 static __always_inline bool aarch64_insn_is_load_pair(u32 insn)
557 {
558 	return aarch64_insn_is_ldp(insn) ||
559 	       aarch64_insn_is_ldp_pre(insn) ||
560 	       aarch64_insn_is_ldp_post(insn);
561 }
562 
563 static __always_inline bool aarch64_insn_uses_literal(u32 insn)
564 {
565 	/* ldr/ldrsw (literal), prfm */
566 
567 	return aarch64_insn_is_ldr_lit(insn) ||
568 	       aarch64_insn_is_ldrsw_lit(insn) ||
569 	       aarch64_insn_is_adr_adrp(insn) ||
570 	       aarch64_insn_is_prfm_lit(insn);
571 }
572 
573 enum aarch64_insn_encoding_class aarch64_get_insn_class(u32 insn);
574 u64 aarch64_insn_decode_immediate(enum aarch64_insn_imm_type type, u32 insn);
575 u32 aarch64_insn_encode_immediate(enum aarch64_insn_imm_type type,
576 				  u32 insn, u64 imm);
577 u32 aarch64_insn_decode_register(enum aarch64_insn_register_type type,
578 					 u32 insn);
579 u32 aarch64_insn_gen_branch_imm(unsigned long pc, unsigned long addr,
580 				enum aarch64_insn_branch_type type);
581 u32 aarch64_insn_gen_comp_branch_imm(unsigned long pc, unsigned long addr,
582 				     enum aarch64_insn_register reg,
583 				     enum aarch64_insn_variant variant,
584 				     enum aarch64_insn_branch_type type);
585 u32 aarch64_insn_gen_cond_branch_imm(unsigned long pc, unsigned long addr,
586 				     enum aarch64_insn_condition cond);
587 
588 static __always_inline u32
589 aarch64_insn_gen_hint(enum aarch64_insn_hint_cr_op op)
590 {
591 	return aarch64_insn_get_hint_value() | op;
592 }
593 
594 static __always_inline u32 aarch64_insn_gen_nop(void)
595 {
596 	return aarch64_insn_gen_hint(AARCH64_INSN_HINT_NOP);
597 }
598 
599 static __always_inline bool aarch64_insn_is_nop(u32 insn)
600 {
601 	return insn == aarch64_insn_gen_nop();
602 }
603 
604 u32 aarch64_insn_gen_branch_reg(enum aarch64_insn_register reg,
605 				enum aarch64_insn_branch_type type);
606 u32 aarch64_insn_gen_load_store_reg(enum aarch64_insn_register reg,
607 				    enum aarch64_insn_register base,
608 				    enum aarch64_insn_register offset,
609 				    enum aarch64_insn_size_type size,
610 				    enum aarch64_insn_ldst_type type);
611 u32 aarch64_insn_gen_load_store_imm(enum aarch64_insn_register reg,
612 				    enum aarch64_insn_register base,
613 				    unsigned int imm,
614 				    enum aarch64_insn_size_type size,
615 				    enum aarch64_insn_ldst_type type);
616 u32 aarch64_insn_gen_load_literal(unsigned long pc, unsigned long addr,
617 				  enum aarch64_insn_register reg,
618 				  bool is64bit);
619 u32 aarch64_insn_gen_load_store_pair(enum aarch64_insn_register reg1,
620 				     enum aarch64_insn_register reg2,
621 				     enum aarch64_insn_register base,
622 				     int offset,
623 				     enum aarch64_insn_variant variant,
624 				     enum aarch64_insn_ldst_type type);
625 u32 aarch64_insn_gen_load_acq_store_rel(enum aarch64_insn_register reg,
626 					enum aarch64_insn_register base,
627 					enum aarch64_insn_size_type size,
628 					enum aarch64_insn_ldst_type type);
629 u32 aarch64_insn_gen_load_store_ex(enum aarch64_insn_register reg,
630 				   enum aarch64_insn_register base,
631 				   enum aarch64_insn_register state,
632 				   enum aarch64_insn_size_type size,
633 				   enum aarch64_insn_ldst_type type);
634 u32 aarch64_insn_gen_add_sub_imm(enum aarch64_insn_register dst,
635 				 enum aarch64_insn_register src,
636 				 int imm, enum aarch64_insn_variant variant,
637 				 enum aarch64_insn_adsb_type type);
638 u32 aarch64_insn_gen_adr(unsigned long pc, unsigned long addr,
639 			 enum aarch64_insn_register reg,
640 			 enum aarch64_insn_adr_type type);
641 u32 aarch64_insn_gen_bitfield(enum aarch64_insn_register dst,
642 			      enum aarch64_insn_register src,
643 			      int immr, int imms,
644 			      enum aarch64_insn_variant variant,
645 			      enum aarch64_insn_bitfield_type type);
646 u32 aarch64_insn_gen_movewide(enum aarch64_insn_register dst,
647 			      int imm, int shift,
648 			      enum aarch64_insn_variant variant,
649 			      enum aarch64_insn_movewide_type type);
650 u32 aarch64_insn_gen_add_sub_shifted_reg(enum aarch64_insn_register dst,
651 					 enum aarch64_insn_register src,
652 					 enum aarch64_insn_register reg,
653 					 int shift,
654 					 enum aarch64_insn_variant variant,
655 					 enum aarch64_insn_adsb_type type);
656 u32 aarch64_insn_gen_add_sub_extended_reg(enum aarch64_insn_register dst,
657 					  enum aarch64_insn_register src,
658 					  enum aarch64_insn_register reg,
659 					  enum aarch64_insn_extend_type extend,
660 					  int shift,
661 					  enum aarch64_insn_variant variant,
662 					  enum aarch64_insn_adsb_type type);
663 u32 aarch64_insn_gen_data1(enum aarch64_insn_register dst,
664 			   enum aarch64_insn_register src,
665 			   enum aarch64_insn_variant variant,
666 			   enum aarch64_insn_data1_type type);
667 u32 aarch64_insn_gen_data2(enum aarch64_insn_register dst,
668 			   enum aarch64_insn_register src,
669 			   enum aarch64_insn_register reg,
670 			   enum aarch64_insn_variant variant,
671 			   enum aarch64_insn_data2_type type);
672 u32 aarch64_insn_gen_data3(enum aarch64_insn_register dst,
673 			   enum aarch64_insn_register src,
674 			   enum aarch64_insn_register reg1,
675 			   enum aarch64_insn_register reg2,
676 			   enum aarch64_insn_variant variant,
677 			   enum aarch64_insn_data3_type type);
678 u32 aarch64_insn_gen_logical_shifted_reg(enum aarch64_insn_register dst,
679 					 enum aarch64_insn_register src,
680 					 enum aarch64_insn_register reg,
681 					 int shift,
682 					 enum aarch64_insn_variant variant,
683 					 enum aarch64_insn_logic_type type);
684 u32 aarch64_insn_gen_move_reg(enum aarch64_insn_register dst,
685 			      enum aarch64_insn_register src,
686 			      enum aarch64_insn_variant variant);
687 u32 aarch64_insn_gen_logical_immediate(enum aarch64_insn_logic_type type,
688 				       enum aarch64_insn_variant variant,
689 				       enum aarch64_insn_register Rn,
690 				       enum aarch64_insn_register Rd,
691 				       u64 imm);
692 u32 aarch64_insn_gen_extr(enum aarch64_insn_variant variant,
693 			  enum aarch64_insn_register Rm,
694 			  enum aarch64_insn_register Rn,
695 			  enum aarch64_insn_register Rd,
696 			  u8 lsb);
697 u32 aarch64_insn_gen_atomic_ld_op(enum aarch64_insn_register result,
698 				  enum aarch64_insn_register address,
699 				  enum aarch64_insn_register value,
700 				  enum aarch64_insn_size_type size,
701 				  enum aarch64_insn_mem_atomic_op op,
702 				  enum aarch64_insn_mem_order_type order);
703 u32 aarch64_insn_gen_cas(enum aarch64_insn_register result,
704 			 enum aarch64_insn_register address,
705 			 enum aarch64_insn_register value,
706 			 enum aarch64_insn_size_type size,
707 			 enum aarch64_insn_mem_order_type order);
708 u32 aarch64_insn_gen_dmb(enum aarch64_insn_mb_type type);
709 u32 aarch64_insn_gen_dsb(enum aarch64_insn_mb_type type);
710 u32 aarch64_insn_gen_mrs(enum aarch64_insn_register result,
711 			 enum aarch64_insn_system_register sysreg);
712 
713 s32 aarch64_get_branch_offset(u32 insn);
714 u32 aarch64_set_branch_offset(u32 insn, s32 offset);
715 
716 s32 aarch64_insn_adrp_get_offset(u32 insn);
717 u32 aarch64_insn_adrp_set_offset(u32 insn, s32 offset);
718 
719 bool aarch32_insn_is_wide(u32 insn);
720 
721 #define A32_RN_OFFSET	16
722 #define A32_RT_OFFSET	12
723 #define A32_RT2_OFFSET	 0
724 
725 u32 aarch64_insn_extract_system_reg(u32 insn);
726 u32 aarch32_insn_extract_reg_num(u32 insn, int offset);
727 u32 aarch32_insn_mcr_extract_opc2(u32 insn);
728 u32 aarch32_insn_mcr_extract_crm(u32 insn);
729 
730 typedef bool (pstate_check_t)(unsigned long);
731 extern pstate_check_t * const aarch32_opcode_cond_checks[16];
732 
733 #endif /* __ASSEMBLER__ */
734 
735 #endif	/* __ASM_INSN_H */
736