xref: /openbmc/linux/arch/mips/include/asm/uasm.h (revision f7c036c1)
1 /*
2  * This file is subject to the terms and conditions of the GNU General Public
3  * License.  See the file "COPYING" in the main directory of this archive
4  * for more details.
5  *
6  * Copyright (C) 2004, 2005, 2006, 2008	 Thiemo Seufer
7  * Copyright (C) 2005  Maciej W. Rozycki
8  * Copyright (C) 2006  Ralf Baechle (ralf@linux-mips.org)
9  * Copyright (C) 2012, 2013  MIPS Technologies, Inc.  All rights reserved.
10  */
11 
12 #ifndef __ASM_UASM_H
13 #define __ASM_UASM_H
14 
15 #include <linux/types.h>
16 
17 #ifdef CONFIG_EXPORT_UASM
18 #include <linux/export.h>
19 #define UASM_EXPORT_SYMBOL(sym) EXPORT_SYMBOL(sym)
20 #else
21 #define UASM_EXPORT_SYMBOL(sym)
22 #endif
23 
24 #define Ip_u1u2u3(op)							\
25 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
26 
27 #define Ip_u2u1u3(op)							\
28 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
29 
30 #define Ip_u3u2u1(op)							\
31 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
32 
33 #define Ip_u3u1u2(op)							\
34 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
35 
36 #define Ip_u1u2s3(op)							\
37 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, signed int c)
38 
39 #define Ip_u2s3u1(op)							\
40 void uasm_i##op(u32 **buf, unsigned int a, signed int b, unsigned int c)
41 
42 #define Ip_s3s1s2(op)							\
43 void uasm_i##op(u32 **buf, int a, int b, int c)
44 
45 #define Ip_u2u1s3(op)							\
46 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, signed int c)
47 
48 #define Ip_u2u1msbu3(op)						\
49 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c, \
50 	   unsigned int d)
51 
52 #define Ip_u1u2(op)							\
53 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b)
54 
55 #define Ip_u2u1(op)							\
56 void uasm_i##op(u32 **buf, unsigned int a, unsigned int b)
57 
58 #define Ip_u1s2(op)							\
59 void uasm_i##op(u32 **buf, unsigned int a, signed int b)
60 
61 #define Ip_u1(op) void uasm_i##op(u32 **buf, unsigned int a)
62 
63 #define Ip_0(op) void uasm_i##op(u32 **buf)
64 
65 Ip_u2u1s3(_addiu);
66 Ip_u3u1u2(_addu);
67 Ip_u3u1u2(_and);
68 Ip_u2u1u3(_andi);
69 Ip_u1u2s3(_bbit0);
70 Ip_u1u2s3(_bbit1);
71 Ip_u1u2s3(_beq);
72 Ip_u1u2s3(_beql);
73 Ip_u1s2(_bgez);
74 Ip_u1s2(_bgezl);
75 Ip_u1s2(_bgtz);
76 Ip_u1s2(_blez);
77 Ip_u1s2(_bltz);
78 Ip_u1s2(_bltzl);
79 Ip_u1u2s3(_bne);
80 Ip_u1(_break);
81 Ip_u2s3u1(_cache);
82 Ip_u1u2(_cfc1);
83 Ip_u2u1(_cfcmsa);
84 Ip_u1u2(_ctc1);
85 Ip_u2u1(_ctcmsa);
86 Ip_u2u1s3(_daddiu);
87 Ip_u3u1u2(_daddu);
88 Ip_u1u2(_ddivu);
89 Ip_u3u1u2(_ddivu_r6);
90 Ip_u1(_di);
91 Ip_u2u1msbu3(_dins);
92 Ip_u2u1msbu3(_dinsm);
93 Ip_u2u1msbu3(_dinsu);
94 Ip_u1u2(_divu);
95 Ip_u3u1u2(_divu_r6);
96 Ip_u1u2u3(_dmfc0);
97 Ip_u3u1u2(_dmodu);
98 Ip_u1u2u3(_dmtc0);
99 Ip_u1u2(_dmultu);
100 Ip_u3u1u2(_dmulu);
101 Ip_u2u1u3(_drotr);
102 Ip_u2u1u3(_drotr32);
103 Ip_u2u1(_dsbh);
104 Ip_u2u1(_dshd);
105 Ip_u2u1u3(_dsll);
106 Ip_u2u1u3(_dsll32);
107 Ip_u3u2u1(_dsllv);
108 Ip_u2u1u3(_dsra);
109 Ip_u2u1u3(_dsra32);
110 Ip_u3u2u1(_dsrav);
111 Ip_u2u1u3(_dsrl);
112 Ip_u2u1u3(_dsrl32);
113 Ip_u3u2u1(_dsrlv);
114 Ip_u3u1u2(_dsubu);
115 Ip_0(_eret);
116 Ip_u2u1msbu3(_ext);
117 Ip_u2u1msbu3(_ins);
118 Ip_u1(_j);
119 Ip_u1(_jal);
120 Ip_u2u1(_jalr);
121 Ip_u1(_jr);
122 Ip_u2s3u1(_lb);
123 Ip_u2s3u1(_lbu);
124 Ip_u2s3u1(_ld);
125 Ip_u3u1u2(_ldx);
126 Ip_u2s3u1(_lh);
127 Ip_u2s3u1(_lhu);
128 Ip_u2s3u1(_ll);
129 Ip_u2s3u1(_lld);
130 Ip_u1s2(_lui);
131 Ip_u2s3u1(_lw);
132 Ip_u2s3u1(_lwu);
133 Ip_u3u1u2(_lwx);
134 Ip_u1u2u3(_mfc0);
135 Ip_u1u2u3(_mfhc0);
136 Ip_u1(_mfhi);
137 Ip_u1(_mflo);
138 Ip_u3u1u2(_modu);
139 Ip_u3u1u2(_movn);
140 Ip_u3u1u2(_movz);
141 Ip_u1u2u3(_mtc0);
142 Ip_u1u2u3(_mthc0);
143 Ip_u1(_mthi);
144 Ip_u1(_mtlo);
145 Ip_u3u1u2(_mul);
146 Ip_u1u2(_multu);
147 Ip_u3u1u2(_mulu);
148 Ip_u3u1u2(_muhu);
149 Ip_u3u1u2(_nor);
150 Ip_u3u1u2(_or);
151 Ip_u2u1u3(_ori);
152 Ip_u2s3u1(_pref);
153 Ip_0(_rfe);
154 Ip_u2u1u3(_rotr);
155 Ip_u2s3u1(_sb);
156 Ip_u2s3u1(_sc);
157 Ip_u2s3u1(_scd);
158 Ip_u2s3u1(_sd);
159 Ip_u3u1u2(_seleqz);
160 Ip_u3u1u2(_selnez);
161 Ip_u2s3u1(_sh);
162 Ip_u2u1u3(_sll);
163 Ip_u3u2u1(_sllv);
164 Ip_s3s1s2(_slt);
165 Ip_u2u1s3(_slti);
166 Ip_u2u1s3(_sltiu);
167 Ip_u3u1u2(_sltu);
168 Ip_u2u1u3(_sra);
169 Ip_u3u2u1(_srav);
170 Ip_u2u1u3(_srl);
171 Ip_u3u2u1(_srlv);
172 Ip_u3u1u2(_subu);
173 Ip_u2s3u1(_sw);
174 Ip_u1(_sync);
175 Ip_u1(_syscall);
176 Ip_0(_tlbp);
177 Ip_0(_tlbr);
178 Ip_0(_tlbwi);
179 Ip_0(_tlbwr);
180 Ip_u1(_wait);
181 Ip_u2u1(_wsbh);
182 Ip_u3u1u2(_xor);
183 Ip_u2u1u3(_xori);
184 Ip_u2u1(_yield);
185 Ip_u1u2(_ldpte);
186 Ip_u2u1u3(_lddir);
187 
188 /* Handle labels. */
189 struct uasm_label {
190 	u32 *addr;
191 	int lab;
192 };
193 
194 void uasm_build_label(struct uasm_label **lab, u32 *addr,
195 			int lid);
196 #ifdef CONFIG_64BIT
197 int uasm_in_compat_space_p(long addr);
198 #endif
199 int uasm_rel_hi(long val);
200 int uasm_rel_lo(long val);
201 void UASM_i_LA_mostly(u32 **buf, unsigned int rs, long addr);
202 void UASM_i_LA(u32 **buf, unsigned int rs, long addr);
203 
204 #define UASM_L_LA(lb)							\
205 static inline void uasm_l##lb(struct uasm_label **lab, u32 *addr)	\
206 {									\
207 	uasm_build_label(lab, addr, label##lb);				\
208 }
209 
210 /* convenience macros for instructions */
211 #ifdef CONFIG_64BIT
212 # define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_daddiu(buf, rs, rt, val)
213 # define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_daddu(buf, rs, rt, rd)
214 # define UASM_i_LL(buf, rs, rt, off) uasm_i_lld(buf, rs, rt, off)
215 # define UASM_i_LW(buf, rs, rt, off) uasm_i_ld(buf, rs, rt, off)
216 # define UASM_i_LWX(buf, rs, rt, rd) uasm_i_ldx(buf, rs, rt, rd)
217 # define UASM_i_MFC0(buf, rt, rd...) uasm_i_dmfc0(buf, rt, rd)
218 # define UASM_i_MTC0(buf, rt, rd...) uasm_i_dmtc0(buf, rt, rd)
219 # define UASM_i_ROTR(buf, rs, rt, sh) uasm_i_drotr(buf, rs, rt, sh)
220 # define UASM_i_SC(buf, rs, rt, off) uasm_i_scd(buf, rs, rt, off)
221 # define UASM_i_SLL(buf, rs, rt, sh) uasm_i_dsll(buf, rs, rt, sh)
222 # define UASM_i_SRA(buf, rs, rt, sh) uasm_i_dsra(buf, rs, rt, sh)
223 # define UASM_i_SRL(buf, rs, rt, sh) uasm_i_dsrl(buf, rs, rt, sh)
224 # define UASM_i_SRL_SAFE(buf, rs, rt, sh) uasm_i_dsrl_safe(buf, rs, rt, sh)
225 # define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_dsubu(buf, rs, rt, rd)
226 # define UASM_i_SW(buf, rs, rt, off) uasm_i_sd(buf, rs, rt, off)
227 #else
228 # define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_addiu(buf, rs, rt, val)
229 # define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_addu(buf, rs, rt, rd)
230 # define UASM_i_LL(buf, rs, rt, off) uasm_i_ll(buf, rs, rt, off)
231 # define UASM_i_LW(buf, rs, rt, off) uasm_i_lw(buf, rs, rt, off)
232 # define UASM_i_LWX(buf, rs, rt, rd) uasm_i_lwx(buf, rs, rt, rd)
233 # define UASM_i_MFC0(buf, rt, rd...) uasm_i_mfc0(buf, rt, rd)
234 # define UASM_i_MTC0(buf, rt, rd...) uasm_i_mtc0(buf, rt, rd)
235 # define UASM_i_ROTR(buf, rs, rt, sh) uasm_i_rotr(buf, rs, rt, sh)
236 # define UASM_i_SC(buf, rs, rt, off) uasm_i_sc(buf, rs, rt, off)
237 # define UASM_i_SLL(buf, rs, rt, sh) uasm_i_sll(buf, rs, rt, sh)
238 # define UASM_i_SRA(buf, rs, rt, sh) uasm_i_sra(buf, rs, rt, sh)
239 # define UASM_i_SRL(buf, rs, rt, sh) uasm_i_srl(buf, rs, rt, sh)
240 # define UASM_i_SRL_SAFE(buf, rs, rt, sh) uasm_i_srl(buf, rs, rt, sh)
241 # define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_subu(buf, rs, rt, rd)
242 # define UASM_i_SW(buf, rs, rt, off) uasm_i_sw(buf, rs, rt, off)
243 #endif
244 
245 #define uasm_i_b(buf, off) uasm_i_beq(buf, 0, 0, off)
246 #define uasm_i_beqz(buf, rs, off) uasm_i_beq(buf, rs, 0, off)
247 #define uasm_i_beqzl(buf, rs, off) uasm_i_beql(buf, rs, 0, off)
248 #define uasm_i_bnez(buf, rs, off) uasm_i_bne(buf, rs, 0, off)
249 #define uasm_i_bnezl(buf, rs, off) uasm_i_bnel(buf, rs, 0, off)
250 #define uasm_i_ehb(buf) uasm_i_sll(buf, 0, 0, 3)
251 #define uasm_i_move(buf, a, b) UASM_i_ADDU(buf, a, 0, b)
252 #ifdef CONFIG_CPU_NOP_WORKAROUNDS
253 #define uasm_i_nop(buf) uasm_i_or(buf, 1, 1, 0)
254 #else
255 #define uasm_i_nop(buf) uasm_i_sll(buf, 0, 0, 0)
256 #endif
257 #define uasm_i_ssnop(buf) uasm_i_sll(buf, 0, 0, 1)
258 
uasm_i_drotr_safe(u32 ** p,unsigned int a1,unsigned int a2,unsigned int a3)259 static inline void uasm_i_drotr_safe(u32 **p, unsigned int a1,
260 				     unsigned int a2, unsigned int a3)
261 {
262 	if (a3 < 32)
263 		uasm_i_drotr(p, a1, a2, a3);
264 	else
265 		uasm_i_drotr32(p, a1, a2, a3 - 32);
266 }
267 
uasm_i_dsll_safe(u32 ** p,unsigned int a1,unsigned int a2,unsigned int a3)268 static inline void uasm_i_dsll_safe(u32 **p, unsigned int a1,
269 				    unsigned int a2, unsigned int a3)
270 {
271 	if (a3 < 32)
272 		uasm_i_dsll(p, a1, a2, a3);
273 	else
274 		uasm_i_dsll32(p, a1, a2, a3 - 32);
275 }
276 
uasm_i_dsrl_safe(u32 ** p,unsigned int a1,unsigned int a2,unsigned int a3)277 static inline void uasm_i_dsrl_safe(u32 **p, unsigned int a1,
278 				    unsigned int a2, unsigned int a3)
279 {
280 	if (a3 < 32)
281 		uasm_i_dsrl(p, a1, a2, a3);
282 	else
283 		uasm_i_dsrl32(p, a1, a2, a3 - 32);
284 }
285 
uasm_i_dsra_safe(u32 ** p,unsigned int a1,unsigned int a2,unsigned int a3)286 static inline void uasm_i_dsra_safe(u32 **p, unsigned int a1,
287 				    unsigned int a2, unsigned int a3)
288 {
289 	if (a3 < 32)
290 		uasm_i_dsra(p, a1, a2, a3);
291 	else
292 		uasm_i_dsra32(p, a1, a2, a3 - 32);
293 }
294 
295 /* Handle relocations. */
296 struct uasm_reloc {
297 	u32 *addr;
298 	unsigned int type;
299 	int lab;
300 };
301 
302 /* This is zero so we can use zeroed label arrays. */
303 #define UASM_LABEL_INVALID 0
304 
305 void uasm_r_mips_pc16(struct uasm_reloc **rel, u32 *addr, int lid);
306 void uasm_resolve_relocs(struct uasm_reloc *rel, struct uasm_label *lab);
307 void uasm_move_relocs(struct uasm_reloc *rel, u32 *first, u32 *end, long off);
308 void uasm_move_labels(struct uasm_label *lab, u32 *first, u32 *end, long off);
309 void uasm_copy_handler(struct uasm_reloc *rel, struct uasm_label *lab,
310 	u32 *first, u32 *end, u32 *target);
311 int uasm_insn_has_bdelay(struct uasm_reloc *rel, u32 *addr);
312 
313 /* Convenience functions for labeled branches. */
314 void uasm_il_b(u32 **p, struct uasm_reloc **r, int lid);
315 void uasm_il_bbit0(u32 **p, struct uasm_reloc **r, unsigned int reg,
316 		   unsigned int bit, int lid);
317 void uasm_il_bbit1(u32 **p, struct uasm_reloc **r, unsigned int reg,
318 		   unsigned int bit, int lid);
319 void uasm_il_beq(u32 **p, struct uasm_reloc **r, unsigned int r1,
320 		 unsigned int r2, int lid);
321 void uasm_il_beqz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
322 void uasm_il_beqzl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
323 void uasm_il_bgezl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
324 void uasm_il_bgez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
325 void uasm_il_bltz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
326 void uasm_il_bne(u32 **p, struct uasm_reloc **r, unsigned int reg1,
327 		 unsigned int reg2, int lid);
328 void uasm_il_bnez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
329 
330 #endif /* __ASM_UASM_H */
331