1@c Copyright (C) 2006-2014 Free Software Foundation, Inc.
2@c This is part of the GAS manual.
3@c For copying conditions, see the file as.texinfo.
4
5@ifset GENERIC
6@page
7@node AVR-Dependent
8@chapter AVR Dependent Features
9@end ifset
10
11@ifclear GENERIC
12@node Machine Dependencies
13@chapter AVR Dependent Features
14@end ifclear
15
16@cindex AVR support
17@menu
18* AVR Options::              Options
19* AVR Syntax::               Syntax
20* AVR Opcodes::              Opcodes
21@end menu
22
23@node AVR Options
24@section Options
25@cindex AVR options (none)
26@cindex options for AVR (none)
27
28@table @code
29
30@cindex @code{-mmcu=} command line option, AVR
31@item -mmcu=@var{mcu}
32Specify ATMEL AVR instruction set or MCU type.
33
34Instruction set avr1 is for the minimal AVR core, not supported by the C
35compiler, only for assembler programs (MCU types: at90s1200,
36attiny11, attiny12, attiny15, attiny28).
37
38Instruction set avr2 (default) is for the classic AVR core with up to
398K program memory space (MCU types: at90s2313, at90s2323, at90s2333, at90s2343,
40attiny22, attiny26, at90s4414, at90s4433, at90s4434, at90s8515, at90c8534,
41at90s8535).
42
43Instruction set avr25 is for the classic AVR core with up to 8K program memory
44space plus the MOVW instruction (MCU types: attiny13, attiny13a, attiny2313,
45attiny2313a, attiny24, attiny24a, attiny4313, attiny44, attiny44a, attiny84,
46attiny84a, attiny25, attiny45, attiny85, attiny261, attiny261a, attiny461,
47attiny461a, attiny861, attiny861a, attiny87, attiny43u, attiny48, attiny88,
48attiny828, at86rf401, ata6289, ata5272).
49
50Instruction set avr3 is for the classic AVR core with up to 128K program
51memory space (MCU types: at43usb355, at76c711).
52
53Instruction set avr31 is for the classic AVR core with exactly 128K program
54memory space (MCU types: atmega103, at43usb320).
55
56Instruction set avr35 is for classic AVR core plus MOVW, CALL, and JMP
57instructions (MCU types: attiny167, attiny1634, at90usb82, at90usb162,
58atmega8u2, atmega16u2, atmega32u2, ata5505).
59
60Instruction set avr4 is for the enhanced AVR core with up to 8K program
61memory space (MCU types: atmega48, atmega48a, atmega48pa, atmega48p, atmega8,
62atmega8a, atmega88, atmega88a, atmega88p, atmega88pa, atmega8515, atmega8535,
63atmega8hva, at90pwm1, at90pwm2, at90pwm2b, at90pwm3, at90pwm3b, at90pwm81,
64ata6285, ata6286).
65
66Instruction set avr5 is for the enhanced AVR core with up to 128K program
67memory space (MCU types: at90pwm161, atmega16, atmega16a, atmega161, atmega162,
68atmega163, atmega164a, atmega164p, atmega164pa, atmega165, atmega165a,
69atmega165p, atmega165pa, atmega168, atmega168a, atmega168p, atmega168pa,
70atmega169, atmega169a, atmega169p, atmega169pa, atmega32, atmega323, atmega324a,
71atmega324p, atmega324pa, atmega325, atmega325a, atmega32, atmega32a, atmega323,
72atmega324a, atmega324p, atmega324pa, atmega325, atmega325a, atmega325p,
73atmega325p, atmega325pa, atmega3250, atmega3250a, atmega3250p, atmega3250pa,
74atmega328, atmega328p, atmega329, atmega329a, atmega329p, atmega329pa,
75atmega3290a, atmega3290p, atmega3290pa, atmega406, atmega64, atmega64a,
76atmega64rfr2, atmega644rfr2, atmega640, atmega644, atmega644a, atmega644p,
77atmega644pa, atmega645, atmega645a, atmega645p, atmega6450, atmega6450a,
78atmega6450p, atmega649, atmega649a, atmega649p, atmega6490, atmega6490a,
79atmega6490p, atmega16hva, atmega16hva2, atmega16hvb, atmega16hvbrevb,
80atmega32hvb, atmega32hvbrevb, atmega64hve, at90can32, at90can64, at90pwm161,
81at90pwm216, at90pwm316, atmega32c1, atmega64c1, atmega16m1, atmega32m1,
82atmega64m1, atmega16u4, atmega32u4, atmega32u6, at90usb646, at90usb647, at94k,
83at90scr100, ata5790, ata5795).
84
85Instruction set avr51 is for the enhanced AVR core with exactly 128K
86program memory space (MCU types: atmega128, atmega128a, atmega1280,
87atmega1281, atmega1284, atmega1284p, atmega128rfa1, atmega128rfr2,
88atmega1284rfr2, at90can128, at90usb1286, at90usb1287, m3000).
89
90Instruction set avr6 is for the enhanced AVR core with a 3-byte PC
91(MCU types: atmega2560, atmega2561, atmega256rfr2, atmega2564rfr2).
92
93Instruction set avrxmega2 is for the XMEGA AVR core with 8K to 64K
94program memory space and less than 64K data space (MCU types:
95atxmega16a4, atxmega16a4u, atxmega16c4, atxmega16d4, atxmega16x1,
96atxmega32a4, atxmega32a4u, atxmega32c4, atxmega32d4, atxmega16e5,
97atxmega8e5, atxmega32e5, atxmega32x1).
98
99Instruction set avrxmega3 is for the XMEGA AVR core with 8K to 64K
100program memory space and greater than 64K data space (MCU types:
101none).
102
103Instruction set avrxmega4 is for the XMEGA AVR core with up to 64K
104program memory space and less than 64K data space (MCU types:
105atxmega64a3, atxmega64a3u, atxmega64a4u, atxmega64b1, atxmega64b3,
106atxmega64c3, atxmega64d3, atxmega64d4).
107
108Instruction set avrxmega5 is for the XMEGA AVR core with up to 64K
109program memory space and greater than 64K data space (MCU types:
110atxmega64a1, atxmega64a1u).
111
112Instruction set avrxmega6 is for the XMEGA AVR core with larger than
11364K program memory space and less than 64K data space (MCU types:
114atxmega128a3, atxmega128a3u, atxmega128c3, atxmega128d3, atxmega128d4,
115atxmega192a3, atxmega192a3u, atxmega128b1, atxmega128b3, atxmega192c3,
116atxmega192d3, atxmega256a3, atxmega256a3u, atxmega256a3b,
117atxmega256a3bu, atxmega256c3, atxmega256d3, atxmega384c3,
118atxmega256d3).
119
120Instruction set avrxmega7 is for the XMEGA AVR core with larger than
12164K program memory space and greater than 64K data space (MCU types:
122atxmega128a1, atxmega128a1u, atxmega128a4u).
123
124Instruction set avrtiny is for the ATtiny4/5/9/10/20/40
125microcontrollers.
126
127@cindex @code{-mall-opcodes} command line option, AVR
128@item -mall-opcodes
129Accept all AVR opcodes, even if not supported by @code{-mmcu}.
130
131@cindex @code{-mno-skip-bug} command line option, AVR
132@item -mno-skip-bug
133This option disable warnings for skipping two-word instructions.
134
135@cindex @code{-mno-wrap} command line option, AVR
136@item -mno-wrap
137This option reject @code{rjmp/rcall} instructions with 8K wrap-around.
138
139@cindex @code{-mrmw} command line option, AVR
140@item -mrmw
141Accept Read-Modify-Write (@code{XCH,LAC,LAS,LAT}) instructions.
142
143@end table
144
145
146@node AVR Syntax
147@section Syntax
148@menu
149* AVR-Chars::                Special Characters
150* AVR-Regs::                 Register Names
151* AVR-Modifiers::            Relocatable Expression Modifiers
152@end menu
153
154@node AVR-Chars
155@subsection Special Characters
156
157@cindex line comment character, AVR
158@cindex AVR line comment character
159
160The presence of a @samp{;} anywhere on a line indicates the start of a
161comment that extends to the end of that line.
162
163If a @samp{#} appears as the first character of a line, the whole line
164is treated as a comment, but in this case the line can also be a
165logical line number directive (@pxref{Comments}) or a preprocessor
166control command (@pxref{Preprocessing}).
167
168@cindex line separator, AVR
169@cindex statement separator, AVR
170@cindex AVR line separator
171
172The @samp{$} character can be used instead of a newline to separate
173statements.
174
175@node AVR-Regs
176@subsection Register Names
177
178@cindex AVR register names
179@cindex register names, AVR
180
181The AVR has 32 x 8-bit general purpose working registers @samp{r0},
182@samp{r1}, ... @samp{r31}.
183Six of the 32 registers can be used as three 16-bit indirect address
184register pointers for Data Space addressing. One of the these address
185pointers can also be used as an address pointer for look up tables in
186Flash program memory. These added function registers are the 16-bit
187@samp{X}, @samp{Y} and @samp{Z} - registers.
188
189@smallexample
190X = @r{r26:r27}
191Y = @r{r28:r29}
192Z = @r{r30:r31}
193@end smallexample
194
195@node AVR-Modifiers
196@subsection Relocatable Expression Modifiers
197
198@cindex AVR modifiers
199@cindex syntax, AVR
200
201The assembler supports several modifiers when using relocatable addresses
202in AVR instruction operands.  The general syntax is the following:
203
204@smallexample
205modifier(relocatable-expression)
206@end smallexample
207
208@table @code
209@cindex symbol modifiers
210
211@item lo8
212
213This modifier allows you to use bits 0 through 7 of
214an address expression as 8 bit relocatable expression.
215
216@item hi8
217
218This modifier allows you to use bits 7 through 15 of an address expression
219as 8 bit relocatable expression.  This is useful with, for example, the
220AVR @samp{ldi} instruction and @samp{lo8} modifier.
221
222For example
223
224@smallexample
225ldi r26, lo8(sym+10)
226ldi r27, hi8(sym+10)
227@end smallexample
228
229@item hh8
230
231This modifier allows you to use bits 16 through 23 of
232an address expression as 8 bit relocatable expression.
233Also, can be useful for loading 32 bit constants.
234
235@item hlo8
236
237Synonym of @samp{hh8}.
238
239@item hhi8
240
241This modifier allows you to use bits 24 through 31 of
242an expression as 8 bit expression. This is useful with, for example, the
243AVR @samp{ldi} instruction and @samp{lo8}, @samp{hi8}, @samp{hlo8},
244@samp{hhi8}, modifier.
245
246For example
247
248@smallexample
249ldi r26, lo8(285774925)
250ldi r27, hi8(285774925)
251ldi r28, hlo8(285774925)
252ldi r29, hhi8(285774925)
253; r29,r28,r27,r26 = 285774925
254@end smallexample
255
256@item pm_lo8
257
258This modifier allows you to use bits 0 through 7 of
259an address expression as 8 bit relocatable expression.
260This modifier useful for addressing data or code from
261Flash/Program memory. The using of @samp{pm_lo8} similar
262to @samp{lo8}.
263
264@item pm_hi8
265
266This modifier allows you to use bits 8 through 15 of
267an address expression as 8 bit relocatable expression.
268This modifier useful for addressing data or code from
269Flash/Program memory.
270
271@item pm_hh8
272
273This modifier allows you to use bits 15 through 23 of
274an address expression as 8 bit relocatable expression.
275This modifier useful for addressing data or code from
276Flash/Program memory.
277
278@end table
279
280@node AVR Opcodes
281@section Opcodes
282
283@cindex AVR opcode summary
284@cindex opcode summary, AVR
285@cindex mnemonics, AVR
286@cindex instruction summary, AVR
287For detailed information on the AVR machine instruction set, see
288@url{www.atmel.com/products/AVR}.
289
290@code{@value{AS}} implements all the standard AVR opcodes.
291The following table summarizes the AVR opcodes, and their arguments.
292
293@smallexample
294@i{Legend:}
295   r   @r{any register}
296   d   @r{`ldi' register (r16-r31)}
297   v   @r{`movw' even register (r0, r2, ..., r28, r30)}
298   a   @r{`fmul' register (r16-r23)}
299   w   @r{`adiw' register (r24,r26,r28,r30)}
300   e   @r{pointer registers (X,Y,Z)}
301   b   @r{base pointer register and displacement ([YZ]+disp)}
302   z   @r{Z pointer register (for [e]lpm Rd,Z[+])}
303   M   @r{immediate value from 0 to 255}
304   n   @r{immediate value from 0 to 255 ( n = ~M ). Relocation impossible}
305   s   @r{immediate value from 0 to 7}
306   P   @r{Port address value from 0 to 63. (in, out)}
307   p   @r{Port address value from 0 to 31. (cbi, sbi, sbic, sbis)}
308   K   @r{immediate value from 0 to 63 (used in `adiw', `sbiw')}
309   i   @r{immediate value}
310   l   @r{signed pc relative offset from -64 to 63}
311   L   @r{signed pc relative offset from -2048 to 2047}
312   h   @r{absolute code address (call, jmp)}
313   S   @r{immediate value from 0 to 7 (S = s << 4)}
314   ?   @r{use this opcode entry if no parameters, else use next opcode entry}
315
3161001010010001000   clc
3171001010011011000   clh
3181001010011111000   cli
3191001010010101000   cln
3201001010011001000   cls
3211001010011101000   clt
3221001010010111000   clv
3231001010010011000   clz
3241001010000001000   sec
3251001010001011000   seh
3261001010001111000   sei
3271001010000101000   sen
3281001010001001000   ses
3291001010001101000   set
3301001010000111000   sev
3311001010000011000   sez
332100101001SSS1000   bclr    S
333100101000SSS1000   bset    S
3341001010100001001   icall
3351001010000001001   ijmp
3361001010111001000   lpm     ?
3371001000ddddd010+   lpm     r,z
3381001010111011000   elpm    ?
3391001000ddddd011+   elpm    r,z
3400000000000000000   nop
3411001010100001000   ret
3421001010100011000   reti
3431001010110001000   sleep
3441001010110011000   break
3451001010110101000   wdr
3461001010111101000   spm
347000111rdddddrrrr   adc     r,r
348000011rdddddrrrr   add     r,r
349001000rdddddrrrr   and     r,r
350000101rdddddrrrr   cp      r,r
351000001rdddddrrrr   cpc     r,r
352000100rdddddrrrr   cpse    r,r
353001001rdddddrrrr   eor     r,r
354001011rdddddrrrr   mov     r,r
355100111rdddddrrrr   mul     r,r
356001010rdddddrrrr   or      r,r
357000010rdddddrrrr   sbc     r,r
358000110rdddddrrrr   sub     r,r
359001001rdddddrrrr   clr     r
360000011rdddddrrrr   lsl     r
361000111rdddddrrrr   rol     r
362001000rdddddrrrr   tst     r
3630111KKKKddddKKKK   andi    d,M
3640111KKKKddddKKKK   cbr     d,n
3651110KKKKddddKKKK   ldi     d,M
36611101111dddd1111   ser     d
3670110KKKKddddKKKK   ori     d,M
3680110KKKKddddKKKK   sbr     d,M
3690011KKKKddddKKKK   cpi     d,M
3700100KKKKddddKKKK   sbci    d,M
3710101KKKKddddKKKK   subi    d,M
3721111110rrrrr0sss   sbrc    r,s
3731111111rrrrr0sss   sbrs    r,s
3741111100ddddd0sss   bld     r,s
3751111101ddddd0sss   bst     r,s
37610110PPdddddPPPP   in      r,P
37710111PPrrrrrPPPP   out     P,r
37810010110KKddKKKK   adiw    w,K
37910010111KKddKKKK   sbiw    w,K
38010011000pppppsss   cbi     p,s
38110011010pppppsss   sbi     p,s
38210011001pppppsss   sbic    p,s
38310011011pppppsss   sbis    p,s
384111101lllllll000   brcc    l
385111100lllllll000   brcs    l
386111100lllllll001   breq    l
387111101lllllll100   brge    l
388111101lllllll101   brhc    l
389111100lllllll101   brhs    l
390111101lllllll111   brid    l
391111100lllllll111   brie    l
392111100lllllll000   brlo    l
393111100lllllll100   brlt    l
394111100lllllll010   brmi    l
395111101lllllll001   brne    l
396111101lllllll010   brpl    l
397111101lllllll000   brsh    l
398111101lllllll110   brtc    l
399111100lllllll110   brts    l
400111101lllllll011   brvc    l
401111100lllllll011   brvs    l
402111101lllllllsss   brbc    s,l
403111100lllllllsss   brbs    s,l
4041101LLLLLLLLLLLL   rcall   L
4051100LLLLLLLLLLLL   rjmp    L
4061001010hhhhh111h   call    h
4071001010hhhhh110h   jmp     h
4081001010rrrrr0101   asr     r
4091001010rrrrr0000   com     r
4101001010rrrrr1010   dec     r
4111001010rrrrr0011   inc     r
4121001010rrrrr0110   lsr     r
4131001010rrrrr0001   neg     r
4141001000rrrrr1111   pop     r
4151001001rrrrr1111   push    r
4161001010rrrrr0111   ror     r
4171001010rrrrr0010   swap    r
41800000001ddddrrrr   movw    v,v
41900000010ddddrrrr   muls    d,d
420000000110ddd0rrr   mulsu   a,a
421000000110ddd1rrr   fmul    a,a
422000000111ddd0rrr   fmuls   a,a
423000000111ddd1rrr   fmulsu  a,a
4241001001ddddd0000   sts     i,r
4251001000ddddd0000   lds     r,i
42610o0oo0dddddbooo   ldd     r,b
427100!000dddddee-+   ld      r,e
42810o0oo1rrrrrbooo   std     b,r
429100!001rrrrree-+   st      e,r
4301001010100011001   eicall
4311001010000011001   eijmp
432@end smallexample
433