1 /**
2  * @namespace   biew_plugins_II
3  * @file        plugins/disasm/avr/avr_ops.h
4  * @brief       This file contains declaration of Atmel AVR opcodes.
5  * @version     -
6  * @remark      this source file is part of Binary vIEW project (BIEW).
7  *              The Binary vIEW (BIEW) is copyright (C) 1995 Nickols_K.
8  *              All rights reserved. This software is redistributable under the
9  *              licence given in the file "Licence.en" ("Licence.ru" in russian
10  *              translation) distributed in the BIEW archive.
11  * @note        Requires POSIX compatible development system
12  *
13  * @author      Stephan Linz
14  * @since       2003
15  * @note        Development, fixes and improvements
16  *
17  * @note        ported from GNU binutils -- most stuff made by Denis Chertykov
18 **/
19 
20 #define AVR_ISA_1200  0x0001 /* in the beginning there was ... */
21 #define AVR_ISA_LPM   0x0002 /* device has LPM */
22 #define AVR_ISA_LPMX  0x0004 /* device has LPM Rd,Z[+] */
23 #define AVR_ISA_SRAM  0x0008 /* device has SRAM (LD, ST, PUSH, POP, ...) */
24 #define AVR_ISA_MEGA  0x0020 /* device has >8K program memory (JMP and CALL
25 				supported, no 8K wrap on RJMP and RCALL) */
26 #define AVR_ISA_MUL   0x0040 /* device has new core (MUL, MOVW, ...) */
27 #define AVR_ISA_ELPM  0x0080 /* device has >64K program memory (ELPM) */
28 #define AVR_ISA_ELPMX 0x0100 /* device has ELPM Rd,Z[+] */
29 #define AVR_ISA_SPM   0x0200 /* device can program itself */
30 #define AVR_ISA_BRK   0x0400 /* device has BREAK (on-chip debug) */
31 #define AVR_ISA_EIND  0x0800 /* device has >128K program memory (none yet) */
32 
33 #define AVR_ISA_TINY1 (AVR_ISA_1200 | AVR_ISA_LPM)
34 #define AVR_ISA_2xxx (AVR_ISA_TINY1 | AVR_ISA_SRAM)
35 #define AVR_ISA_M8   (AVR_ISA_2xxx | AVR_ISA_MUL | AVR_ISA_LPMX | AVR_ISA_SPM)
36 #define AVR_ISA_M603 (AVR_ISA_2xxx | AVR_ISA_MEGA)
37 #define AVR_ISA_M103 (AVR_ISA_M603 | AVR_ISA_ELPM)
38 #define AVR_ISA_M161 (AVR_ISA_M603 | AVR_ISA_MUL | AVR_ISA_LPMX | AVR_ISA_SPM)
39 #define AVR_ISA_94K  (AVR_ISA_M603 | AVR_ISA_MUL | AVR_ISA_LPMX)
40 #define AVR_ISA_M323 (AVR_ISA_M161 | AVR_ISA_BRK)
41 #define AVR_ISA_M128 (AVR_ISA_M323 | AVR_ISA_ELPM | AVR_ISA_ELPMX)
42 
43 #define AVR_ISA_ALL   0xFFFF
44 
45 #define REGISTER_P(x) ((x) == 'r'		\
46 		       || (x) == 'd'		\
47 		       || (x) == 'w'		\
48 		       || (x) == 'a'		\
49 		       || (x) == 'v')
50 
51 /* Undefined combination of operands - does the register
52    operand overlap with pre-decremented or post-incremented
53    pointer register (like ld r31,Z+)?  */
54 #define AVR_UNDEF_P(x) (((x) & 0xFFED) == 0x91E5 ||		\
55   ((x) & 0xFDEF) == 0x91AD || ((x) & 0xFDEF) == 0x91AE ||	\
56   ((x) & 0xFDEF) == 0x91C9 || ((x) & 0xFDEF) == 0x91CA ||	\
57   ((x) & 0xFDEF) == 0x91E1 || ((x) & 0xFDEF) == 0x91E2)
58 
59 /* Is this a skip instruction {cpse,sbic,sbis,sbrc,sbrs}?  */
60 #define AVR_SKIP_P(x) (((x) & 0xFC00) == 0x1000 ||		\
61   ((x) & 0xFD00) == 0x9900 || ((x) & 0xFC08) == 0xFC00)
62 
63 /* Is this `ldd r,b+0' or `std b+0,r' (b={Y,Z}, disassembled as
64    `ld r,b' or `st b,r' respectively - next opcode entry)?  */
65 #define AVR_DISP0_P(x) (((x) & 0xFC07) == 0x8000)
66 
67 /* identify instruction of return class */
68 #define AVR_RET_CLASS(x) ((x) == 0x9508 || (x) == 0x9518)
69 
70 /* identify instruction of leave class (ex.: pop r1) */
71 #define AVR_LEAVE_CLASS(x) (0)
72 
73 /* identify instruction of jump via virtual table */
74 #define AVR_JMPVVT_CLASS(x) (0)
75 
76 /* identify instruction of jump via PIC */
77 #define AVR_JUMPPIC_CLASS(x) ((x) == 0xC000 || (x) == 0xD000)
78 
79 /* constraint letters
80    r - any register
81    d - `ldi' register (r16-r31)
82    v - `movw' even register (r0, r2, ..., r28, r30)
83    a - `fmul' register (r16-r23)
84    w - `adiw' register (r24,r26,r28,r30)
85    e - pointer registers (X,Y,Z)
86    b - base pointer register and displacement ([YZ]+disp)
87    z - Z pointer register (for [e]lpm Rd,Z[+])
88    M - immediate value from 0 to 255
89    n - immediate value from 0 to 255 ( n = ~M ). Relocation impossible
90    s - immediate value from 0 to 7
91    P - Port address value from 0 to 63. (in, out)
92    p - Port address value from 0 to 31. (cbi, sbi, sbic, sbis)
93    K - immediate value from 0 to 63 (used in `adiw', `sbiw')
94    i - immediate value
95    l - signed pc relative offset from -64 to 63
96    L - signed pc relative offset from -2048 to 2047
97    h - absolute code address (call, jmp)
98    S - immediate value from 0 to 7 (S = s << 4)
99    ? - use this opcode entry if no parameters, else use next opcode entry
100 
101    Order is important - some binary opcodes have more than one name,
102    the disassembler will only see the first match.
103 
104    Remaining undefined opcodes (1699 total - some of them might work
105    as normal instructions if not all of the bits are decoded):
106 
107     0x0001...0x00ff    (255) (known to be decoded as `nop' by the old core)
108    "100100xxxxxxx011"  (128) 0x9[0-3][0-9a-f][3b]
109    "100100xxxxxx1000"   (64) 0x9[0-3][0-9a-f]8
110    "1001001xxxxx01xx"  (128) 0x9[23][0-9a-f][4-7]
111    "1001010xxxxx0100"   (32) 0x9[45][0-9a-f]4
112    "1001010x001x1001"    (4) 0x9[45][23]9
113    "1001010x01xx1001"    (8) 0x9[45][4-7]9
114    "1001010x1xxx1001"   (16) 0x9[45][8-9a-f]9
115    "1001010xxxxx1011"   (32) 0x9[45][0-9a-f]b
116    "10010101001x1000"    (2) 0x95[23]8
117    "1001010101xx1000"    (4) 0x95[4-7]8
118    "1001010110111000"    (1) 0x95b8
119    "1001010111111000"    (1) 0x95f8 (`espm' removed in databook update)
120    "11111xxxxxxx1xxx" (1024) 0xf[8-9a-f][0-9a-f][8-9a-f]
121  */
122 
123 AVR_INSN (clc,  "",    "1001010010001000", 1, AVR_ISA_1200, 0x9488)
124 AVR_INSN (clh,  "",    "1001010011011000", 1, AVR_ISA_1200, 0x94d8)
125 AVR_INSN (cli,  "",    "1001010011111000", 1, AVR_ISA_1200, 0x94f8)
126 AVR_INSN (cln,  "",    "1001010010101000", 1, AVR_ISA_1200, 0x94a8)
127 AVR_INSN (cls,  "",    "1001010011001000", 1, AVR_ISA_1200, 0x94c8)
128 AVR_INSN (clt,  "",    "1001010011101000", 1, AVR_ISA_1200, 0x94e8)
129 AVR_INSN (clv,  "",    "1001010010111000", 1, AVR_ISA_1200, 0x94b8)
130 AVR_INSN (clz,  "",    "1001010010011000", 1, AVR_ISA_1200, 0x9498)
131 
132 AVR_INSN (sec,  "",    "1001010000001000", 1, AVR_ISA_1200, 0x9408)
133 AVR_INSN (seh,  "",    "1001010001011000", 1, AVR_ISA_1200, 0x9458)
134 AVR_INSN (sei,  "",    "1001010001111000", 1, AVR_ISA_1200, 0x9478)
135 AVR_INSN (sen,  "",    "1001010000101000", 1, AVR_ISA_1200, 0x9428)
136 AVR_INSN (ses,  "",    "1001010001001000", 1, AVR_ISA_1200, 0x9448)
137 AVR_INSN (set,  "",    "1001010001101000", 1, AVR_ISA_1200, 0x9468)
138 AVR_INSN (sev,  "",    "1001010000111000", 1, AVR_ISA_1200, 0x9438)
139 AVR_INSN (sez,  "",    "1001010000011000", 1, AVR_ISA_1200, 0x9418)
140 
141    /* Same as {cl,se}[chinstvz] above.  */
142 AVR_INSN (bclr, "S",   "100101001SSS1000", 1, AVR_ISA_1200, 0x9488)
143 AVR_INSN (bset, "S",   "100101000SSS1000", 1, AVR_ISA_1200, 0x9408)
144 
145 AVR_INSN (icall,"",    "1001010100001001", 1, AVR_ISA_2xxx, 0x9509)
146 AVR_INSN (ijmp, "",    "1001010000001001", 1, AVR_ISA_2xxx, 0x9409)
147 
148 AVR_INSN (lpm,  "?",   "1001010111001000", 1, AVR_ISA_TINY1,0x95c8)
149 AVR_INSN (lpm,  "r,z", "1001000ddddd010+", 1, AVR_ISA_LPMX, 0x9004)
150 AVR_INSN (elpm, "?",   "1001010111011000", 1, AVR_ISA_ELPM, 0x95d8)
151 AVR_INSN (elpm, "r,z", "1001000ddddd011+", 1, AVR_ISA_ELPMX,0x9006)
152 
153 AVR_INSN (nop,  "",    "0000000000000000", 1, AVR_ISA_1200, 0x0000)
154 AVR_INSN (ret,  "",    "1001010100001000", 1, AVR_ISA_1200, 0x9508)
155 AVR_INSN (reti, "",    "1001010100011000", 1, AVR_ISA_1200, 0x9518)
156 AVR_INSN (sleep,"",    "1001010110001000", 1, AVR_ISA_1200, 0x9588)
157 AVR_INSN (break,"",    "1001010110011000", 1, AVR_ISA_BRK,  0x9598)
158 AVR_INSN (wdr,  "",    "1001010110101000", 1, AVR_ISA_1200, 0x95a8)
159 AVR_INSN (spm,  "",    "1001010111101000", 1, AVR_ISA_SPM,  0x95e8)
160 
161 AVR_INSN (adc,  "r,r", "000111rdddddrrrr", 1, AVR_ISA_1200, 0x1c00)
162 AVR_INSN (add,  "r,r", "000011rdddddrrrr", 1, AVR_ISA_1200, 0x0c00)
163 AVR_INSN (and,  "r,r", "001000rdddddrrrr", 1, AVR_ISA_1200, 0x2000)
164 AVR_INSN (cp,   "r,r", "000101rdddddrrrr", 1, AVR_ISA_1200, 0x1400)
165 AVR_INSN (cpc,  "r,r", "000001rdddddrrrr", 1, AVR_ISA_1200, 0x0400)
166 AVR_INSN (cpse, "r,r", "000100rdddddrrrr", 1, AVR_ISA_1200, 0x1000)
167 AVR_INSN (eor,  "r,r", "001001rdddddrrrr", 1, AVR_ISA_1200, 0x2400)
168 AVR_INSN (mov,  "r,r", "001011rdddddrrrr", 1, AVR_ISA_1200, 0x2c00)
169 AVR_INSN (mul,  "r,r", "100111rdddddrrrr", 1, AVR_ISA_MUL,  0x9c00)
170 AVR_INSN (or,   "r,r", "001010rdddddrrrr", 1, AVR_ISA_1200, 0x2800)
171 AVR_INSN (sbc,  "r,r", "000010rdddddrrrr", 1, AVR_ISA_1200, 0x0800)
172 AVR_INSN (sub,  "r,r", "000110rdddddrrrr", 1, AVR_ISA_1200, 0x1800)
173 
174    /* Shorthand for {eor,add,adc,and} r,r above.  */
175 AVR_INSN (clr,  "r=r", "001001rdddddrrrr", 1, AVR_ISA_1200, 0x2400)
176 AVR_INSN (lsl,  "r=r", "000011rdddddrrrr", 1, AVR_ISA_1200, 0x0c00)
177 AVR_INSN (rol,  "r=r", "000111rdddddrrrr", 1, AVR_ISA_1200, 0x1c00)
178 AVR_INSN (tst,  "r=r", "001000rdddddrrrr", 1, AVR_ISA_1200, 0x2000)
179 
180 AVR_INSN (andi, "d,M", "0111KKKKddddKKKK", 1, AVR_ISA_1200, 0x7000)
181   /*XXX special case*/
182 AVR_INSN (cbr,  "d,n", "0111KKKKddddKKKK", 1, AVR_ISA_1200, 0x7000)
183 
184 AVR_INSN (ldi,  "d,M", "1110KKKKddddKKKK", 1, AVR_ISA_1200, 0xe000)
185 AVR_INSN (ser,  "d",   "11101111dddd1111", 1, AVR_ISA_1200, 0xef0f)
186 
187 AVR_INSN (ori,  "d,M", "0110KKKKddddKKKK", 1, AVR_ISA_1200, 0x6000)
188 AVR_INSN (sbr,  "d,M", "0110KKKKddddKKKK", 1, AVR_ISA_1200, 0x6000)
189 
190 AVR_INSN (cpi,  "d,M", "0011KKKKddddKKKK", 1, AVR_ISA_1200, 0x3000)
191 AVR_INSN (sbci, "d,M", "0100KKKKddddKKKK", 1, AVR_ISA_1200, 0x4000)
192 AVR_INSN (subi, "d,M", "0101KKKKddddKKKK", 1, AVR_ISA_1200, 0x5000)
193 
194 AVR_INSN (sbrc, "r,s", "1111110rrrrr0sss", 1, AVR_ISA_1200, 0xfc00)
195 AVR_INSN (sbrs, "r,s", "1111111rrrrr0sss", 1, AVR_ISA_1200, 0xfe00)
196 AVR_INSN (bld,  "r,s", "1111100ddddd0sss", 1, AVR_ISA_1200, 0xf800)
197 AVR_INSN (bst,  "r,s", "1111101ddddd0sss", 1, AVR_ISA_1200, 0xfa00)
198 
199 AVR_INSN (in,   "r,P", "10110PPdddddPPPP", 1, AVR_ISA_1200, 0xb000)
200 AVR_INSN (out,  "P,r", "10111PPrrrrrPPPP", 1, AVR_ISA_1200, 0xb800)
201 
202 AVR_INSN (adiw, "w,K", "10010110KKddKKKK", 1, AVR_ISA_2xxx, 0x9600)
203 AVR_INSN (sbiw, "w,K", "10010111KKddKKKK", 1, AVR_ISA_2xxx, 0x9700)
204 
205 AVR_INSN (cbi,  "p,s", "10011000pppppsss", 1, AVR_ISA_1200, 0x9800)
206 AVR_INSN (sbi,  "p,s", "10011010pppppsss", 1, AVR_ISA_1200, 0x9a00)
207 AVR_INSN (sbic, "p,s", "10011001pppppsss", 1, AVR_ISA_1200, 0x9900)
208 AVR_INSN (sbis, "p,s", "10011011pppppsss", 1, AVR_ISA_1200, 0x9b00)
209 
210 AVR_INSN (brcc, "l",   "111101lllllll000", 1, AVR_ISA_1200, 0xf400)
211 AVR_INSN (brcs, "l",   "111100lllllll000", 1, AVR_ISA_1200, 0xf000)
212 AVR_INSN (breq, "l",   "111100lllllll001", 1, AVR_ISA_1200, 0xf001)
213 AVR_INSN (brge, "l",   "111101lllllll100", 1, AVR_ISA_1200, 0xf404)
214 AVR_INSN (brhc, "l",   "111101lllllll101", 1, AVR_ISA_1200, 0xf405)
215 AVR_INSN (brhs, "l",   "111100lllllll101", 1, AVR_ISA_1200, 0xf005)
216 AVR_INSN (brid, "l",   "111101lllllll111", 1, AVR_ISA_1200, 0xf407)
217 AVR_INSN (brie, "l",   "111100lllllll111", 1, AVR_ISA_1200, 0xf007)
218 AVR_INSN (brlo, "l",   "111100lllllll000", 1, AVR_ISA_1200, 0xf000)
219 AVR_INSN (brlt, "l",   "111100lllllll100", 1, AVR_ISA_1200, 0xf004)
220 AVR_INSN (brmi, "l",   "111100lllllll010", 1, AVR_ISA_1200, 0xf002)
221 AVR_INSN (brne, "l",   "111101lllllll001", 1, AVR_ISA_1200, 0xf401)
222 AVR_INSN (brpl, "l",   "111101lllllll010", 1, AVR_ISA_1200, 0xf402)
223 AVR_INSN (brsh, "l",   "111101lllllll000", 1, AVR_ISA_1200, 0xf400)
224 AVR_INSN (brtc, "l",   "111101lllllll110", 1, AVR_ISA_1200, 0xf406)
225 AVR_INSN (brts, "l",   "111100lllllll110", 1, AVR_ISA_1200, 0xf006)
226 AVR_INSN (brvc, "l",   "111101lllllll011", 1, AVR_ISA_1200, 0xf403)
227 AVR_INSN (brvs, "l",   "111100lllllll011", 1, AVR_ISA_1200, 0xf003)
228 
229    /* Same as br?? above.  */
230 AVR_INSN (brbc, "s,l", "111101lllllllsss", 1, AVR_ISA_1200, 0xf400)
231 AVR_INSN (brbs, "s,l", "111100lllllllsss", 1, AVR_ISA_1200, 0xf000)
232 
233 AVR_INSN (rcall, "L",  "1101LLLLLLLLLLLL", 1, AVR_ISA_1200, 0xd000)
234 AVR_INSN (rjmp,  "L",  "1100LLLLLLLLLLLL", 1, AVR_ISA_1200, 0xc000)
235 
236 AVR_INSN (call, "h",   "1001010hhhhh111h", 2, AVR_ISA_MEGA, 0x940e)
237 AVR_INSN (jmp,  "h",   "1001010hhhhh110h", 2, AVR_ISA_MEGA, 0x940c)
238 
239 AVR_INSN (asr,  "r",   "1001010rrrrr0101", 1, AVR_ISA_1200, 0x9405)
240 AVR_INSN (com,  "r",   "1001010rrrrr0000", 1, AVR_ISA_1200, 0x9400)
241 AVR_INSN (dec,  "r",   "1001010rrrrr1010", 1, AVR_ISA_1200, 0x940a)
242 AVR_INSN (inc,  "r",   "1001010rrrrr0011", 1, AVR_ISA_1200, 0x9403)
243 AVR_INSN (lsr,  "r",   "1001010rrrrr0110", 1, AVR_ISA_1200, 0x9406)
244 AVR_INSN (neg,  "r",   "1001010rrrrr0001", 1, AVR_ISA_1200, 0x9401)
245 AVR_INSN (pop,  "r",   "1001000rrrrr1111", 1, AVR_ISA_2xxx, 0x900f)
246 AVR_INSN (push, "r",   "1001001rrrrr1111", 1, AVR_ISA_2xxx, 0x920f)
247 AVR_INSN (ror,  "r",   "1001010rrrrr0111", 1, AVR_ISA_1200, 0x9407)
248 AVR_INSN (swap, "r",   "1001010rrrrr0010", 1, AVR_ISA_1200, 0x9402)
249 
250    /* Known to be decoded as `nop' by the old core.  */
251 AVR_INSN (movw, "v,v", "00000001ddddrrrr", 1, AVR_ISA_MUL,  0x0100)
252 AVR_INSN (muls, "d,d", "00000010ddddrrrr", 1, AVR_ISA_MUL,  0x0200)
253 AVR_INSN (mulsu,"a,a", "000000110ddd0rrr", 1, AVR_ISA_MUL,  0x0300)
254 AVR_INSN (fmul, "a,a", "000000110ddd1rrr", 1, AVR_ISA_MUL,  0x0308)
255 AVR_INSN (fmuls,"a,a", "000000111ddd0rrr", 1, AVR_ISA_MUL,  0x0380)
256 AVR_INSN (fmulsu,"a,a","000000111ddd1rrr", 1, AVR_ISA_MUL,  0x0388)
257 
258 AVR_INSN (sts,  "i,r", "1001001ddddd0000", 2, AVR_ISA_2xxx, 0x9200)
259 AVR_INSN (lds,  "r,i", "1001000ddddd0000", 2, AVR_ISA_2xxx, 0x9000)
260 
261    /* Special case for b+0, `e' must be next entry after `b',
262       b={Y=1,Z=0}, ee={X=11,Y=10,Z=00}, !=1 if -e or e+ or X.  */
263 AVR_INSN (ldd,  "r,b", "10o0oo0dddddbooo", 1, AVR_ISA_2xxx, 0x8000)
264 AVR_INSN (ld,   "r,e", "100!000dddddee-+", 1, AVR_ISA_1200, 0x8000)
265 AVR_INSN (std,  "b,r", "10o0oo1rrrrrbooo", 1, AVR_ISA_2xxx, 0x8200)
266 AVR_INSN (st,   "e,r", "100!001rrrrree-+", 1, AVR_ISA_1200, 0x8200)
267 
268    /* These are for devices that don't exist yet
269       (>128K program memory, PC = EIND:Z).  */
270 AVR_INSN (eicall, "",  "1001010100011001", 1, AVR_ISA_EIND, 0x9519)
271 AVR_INSN (eijmp, "",   "1001010000011001", 1, AVR_ISA_EIND, 0x9419)
272 
273