Merge branch 'docs' of git://git.lwn.net/linux-2.6
[linux-2.6] / arch / mips / mm / uasm.h
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  */
10
11 #include <linux/types.h>
12
13 #define Ip_u1u2u3(op)                                                   \
14 void __cpuinit                                                          \
15 uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
16
17 #define Ip_u2u1u3(op)                                                   \
18 void __cpuinit                                                          \
19 uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
20
21 #define Ip_u3u1u2(op)                                                   \
22 void __cpuinit                                                          \
23 uasm_i##op(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
24
25 #define Ip_u1u2s3(op)                                                   \
26 void __cpuinit                                                          \
27 uasm_i##op(u32 **buf, unsigned int a, unsigned int b, signed int c)
28
29 #define Ip_u2s3u1(op)                                                   \
30 void __cpuinit                                                          \
31 uasm_i##op(u32 **buf, unsigned int a, signed int b, unsigned int c)
32
33 #define Ip_u2u1s3(op)                                                   \
34 void __cpuinit                                                          \
35 uasm_i##op(u32 **buf, unsigned int a, unsigned int b, signed int c)
36
37 #define Ip_u1u2(op)                                                     \
38 void __cpuinit uasm_i##op(u32 **buf, unsigned int a, unsigned int b)
39
40 #define Ip_u1s2(op)                                                     \
41 void __cpuinit uasm_i##op(u32 **buf, unsigned int a, signed int b)
42
43 #define Ip_u1(op) void __cpuinit uasm_i##op(u32 **buf, unsigned int a)
44
45 #define Ip_0(op) void __cpuinit uasm_i##op(u32 **buf)
46
47 Ip_u2u1s3(_addiu);
48 Ip_u3u1u2(_addu);
49 Ip_u2u1u3(_andi);
50 Ip_u3u1u2(_and);
51 Ip_u1u2s3(_beq);
52 Ip_u1u2s3(_beql);
53 Ip_u1s2(_bgez);
54 Ip_u1s2(_bgezl);
55 Ip_u1s2(_bltz);
56 Ip_u1s2(_bltzl);
57 Ip_u1u2s3(_bne);
58 Ip_u1u2u3(_dmfc0);
59 Ip_u1u2u3(_dmtc0);
60 Ip_u2u1s3(_daddiu);
61 Ip_u3u1u2(_daddu);
62 Ip_u2u1u3(_dsll);
63 Ip_u2u1u3(_dsll32);
64 Ip_u2u1u3(_dsra);
65 Ip_u2u1u3(_dsrl);
66 Ip_u2u1u3(_dsrl32);
67 Ip_u3u1u2(_dsubu);
68 Ip_0(_eret);
69 Ip_u1(_j);
70 Ip_u1(_jal);
71 Ip_u1(_jr);
72 Ip_u2s3u1(_ld);
73 Ip_u2s3u1(_ll);
74 Ip_u2s3u1(_lld);
75 Ip_u1s2(_lui);
76 Ip_u2s3u1(_lw);
77 Ip_u1u2u3(_mfc0);
78 Ip_u1u2u3(_mtc0);
79 Ip_u2u1u3(_ori);
80 Ip_0(_rfe);
81 Ip_u2s3u1(_sc);
82 Ip_u2s3u1(_scd);
83 Ip_u2s3u1(_sd);
84 Ip_u2u1u3(_sll);
85 Ip_u2u1u3(_sra);
86 Ip_u2u1u3(_srl);
87 Ip_u3u1u2(_subu);
88 Ip_u2s3u1(_sw);
89 Ip_0(_tlbp);
90 Ip_0(_tlbwi);
91 Ip_0(_tlbwr);
92 Ip_u3u1u2(_xor);
93 Ip_u2u1u3(_xori);
94
95 /* Handle labels. */
96 struct uasm_label {
97         u32 *addr;
98         int lab;
99 };
100
101 void __cpuinit uasm_build_label(struct uasm_label **lab, u32 *addr, int lid);
102 #ifdef CONFIG_64BIT
103 int uasm_in_compat_space_p(long addr);
104 int uasm_rel_highest(long val);
105 int uasm_rel_higher(long val);
106 #endif
107 int uasm_rel_hi(long val);
108 int uasm_rel_lo(long val);
109 void UASM_i_LA_mostly(u32 **buf, unsigned int rs, long addr);
110 void UASM_i_LA(u32 **buf, unsigned int rs, long addr);
111
112 #define UASM_L_LA(lb)                                                   \
113 static inline void __cpuinit uasm_l##lb(struct uasm_label **lab, u32 *addr) \
114 {                                                                       \
115         uasm_build_label(lab, addr, label##lb);                         \
116 }
117
118 /* convenience macros for instructions */
119 #ifdef CONFIG_64BIT
120 # define UASM_i_LW(buf, rs, rt, off) uasm_i_ld(buf, rs, rt, off)
121 # define UASM_i_SW(buf, rs, rt, off) uasm_i_sd(buf, rs, rt, off)
122 # define UASM_i_SLL(buf, rs, rt, sh) uasm_i_dsll(buf, rs, rt, sh)
123 # define UASM_i_SRA(buf, rs, rt, sh) uasm_i_dsra(buf, rs, rt, sh)
124 # define UASM_i_SRL(buf, rs, rt, sh) uasm_i_dsrl(buf, rs, rt, sh)
125 # define UASM_i_MFC0(buf, rt, rd...) uasm_i_dmfc0(buf, rt, rd)
126 # define UASM_i_MTC0(buf, rt, rd...) uasm_i_dmtc0(buf, rt, rd)
127 # define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_daddiu(buf, rs, rt, val)
128 # define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_daddu(buf, rs, rt, rd)
129 # define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_dsubu(buf, rs, rt, rd)
130 # define UASM_i_LL(buf, rs, rt, off) uasm_i_lld(buf, rs, rt, off)
131 # define UASM_i_SC(buf, rs, rt, off) uasm_i_scd(buf, rs, rt, off)
132 #else
133 # define UASM_i_LW(buf, rs, rt, off) uasm_i_lw(buf, rs, rt, off)
134 # define UASM_i_SW(buf, rs, rt, off) uasm_i_sw(buf, rs, rt, off)
135 # define UASM_i_SLL(buf, rs, rt, sh) uasm_i_sll(buf, rs, rt, sh)
136 # define UASM_i_SRA(buf, rs, rt, sh) uasm_i_sra(buf, rs, rt, sh)
137 # define UASM_i_SRL(buf, rs, rt, sh) uasm_i_srl(buf, rs, rt, sh)
138 # define UASM_i_MFC0(buf, rt, rd...) uasm_i_mfc0(buf, rt, rd)
139 # define UASM_i_MTC0(buf, rt, rd...) uasm_i_mtc0(buf, rt, rd)
140 # define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_addiu(buf, rs, rt, val)
141 # define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_addu(buf, rs, rt, rd)
142 # define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_subu(buf, rs, rt, rd)
143 # define UASM_i_LL(buf, rs, rt, off) uasm_i_ll(buf, rs, rt, off)
144 # define UASM_i_SC(buf, rs, rt, off) uasm_i_sc(buf, rs, rt, off)
145 #endif
146
147 #define uasm_i_b(buf, off) uasm_i_beq(buf, 0, 0, off)
148 #define uasm_i_beqz(buf, rs, off) uasm_i_beq(buf, rs, 0, off)
149 #define uasm_i_beqzl(buf, rs, off) uasm_i_beql(buf, rs, 0, off)
150 #define uasm_i_bnez(buf, rs, off) uasm_i_bne(buf, rs, 0, off)
151 #define uasm_i_bnezl(buf, rs, off) uasm_i_bnel(buf, rs, 0, off)
152 #define uasm_i_move(buf, a, b) UASM_i_ADDU(buf, a, 0, b)
153 #define uasm_i_nop(buf) uasm_i_sll(buf, 0, 0, 0)
154 #define uasm_i_ssnop(buf) uasm_i_sll(buf, 0, 0, 1)
155 #define uasm_i_ehb(buf) uasm_i_sll(buf, 0, 0, 3)
156
157 /* Handle relocations. */
158 struct uasm_reloc {
159         u32 *addr;
160         unsigned int type;
161         int lab;
162 };
163
164 /* This is zero so we can use zeroed label arrays. */
165 #define UASM_LABEL_INVALID 0
166
167 void uasm_r_mips_pc16(struct uasm_reloc **rel, u32 *addr, int lid);
168 void uasm_resolve_relocs(struct uasm_reloc *rel, struct uasm_label *lab);
169 void uasm_move_relocs(struct uasm_reloc *rel, u32 *first, u32 *end, long off);
170 void uasm_move_labels(struct uasm_label *lab, u32 *first, u32 *end, long off);
171 void uasm_copy_handler(struct uasm_reloc *rel, struct uasm_label *lab,
172         u32 *first, u32 *end, u32 *target);
173 int uasm_insn_has_bdelay(struct uasm_reloc *rel, u32 *addr);
174
175 /* Convenience functions for labeled branches. */
176 void uasm_il_bltz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
177 void uasm_il_b(u32 **p, struct uasm_reloc **r, int lid);
178 void uasm_il_beqz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
179 void uasm_il_beqzl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
180 void uasm_il_bnez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
181 void uasm_il_bgezl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
182 void uasm_il_bgez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);