gas/doc: Fix "a true results" typo
[binutils-gdb.git] / gas / doc / c-avr.texi
index f20937c5351470332bd36e04fad1a82ea5e84f21..35109acaa34f870f284224951ffe395a63ef9239 100644 (file)
@@ -1,4 +1,4 @@
-@c Copyright (C) 2006-2014 Free Software Foundation, Inc.
+@c Copyright (C) 2006-2022 Free Software Foundation, Inc.
 @c This is part of the GAS manual.
 @c For copying conditions, see the file as.texinfo.
 
@@ -18,6 +18,7 @@
 * AVR Options::              Options
 * AVR Syntax::               Syntax
 * AVR Opcodes::              Opcodes
+* AVR Pseudo Instructions::  Pseudo Instructions
 @end menu
 
 @node AVR Options
@@ -27,7 +28,7 @@
 
 @table @code
 
-@cindex @code{-mmcu=} command line option, AVR
+@cindex @code{-mmcu=} command-line option, AVR
 @item -mmcu=@var{mcu}
 Specify ATMEL AVR instruction set or MCU type.
 
@@ -96,9 +97,12 @@ atxmega16a4, atxmega16a4u, atxmega16c4, atxmega16d4, atxmega16x1,
 atxmega32a4, atxmega32a4u, atxmega32c4, atxmega32d4, atxmega16e5,
 atxmega8e5, atxmega32e5, atxmega32x1).
 
-Instruction set avrxmega3 is for the XMEGA AVR core with 8K to 64K
-program memory space and greater than 64K data space (MCU types:
-none).
+Instruction set avrxmega3 is for the XMEGA AVR core with up to 64K
+of combined program memory and RAM, and with program memory
+visible in the RAM address space (MCU types:
+attiny212, attiny214, attiny412, attiny414, attiny416, attiny417,
+attiny814, attiny816, attiny817, attiny1614, attiny1616, attiny1617,
+attiny3214, attiny3216, attiny3217).
 
 Instruction set avrxmega4 is for the XMEGA AVR core with up to 64K
 program memory space and less than 64K data space (MCU types:
@@ -124,33 +128,43 @@ atxmega128a1, atxmega128a1u, atxmega128a4u).
 Instruction set avrtiny is for the ATtiny4/5/9/10/20/40
 microcontrollers.
 
-@cindex @code{-mall-opcodes} command line option, AVR
+@cindex @code{-mall-opcodes} command-line option, AVR
 @item -mall-opcodes
 Accept all AVR opcodes, even if not supported by @code{-mmcu}.
 
-@cindex @code{-mno-skip-bug} command line option, AVR
+@cindex @code{-mno-skip-bug} command-line option, AVR
 @item -mno-skip-bug
 This option disable warnings for skipping two-word instructions.
 
-@cindex @code{-mno-wrap} command line option, AVR
+@cindex @code{-mno-wrap} command-line option, AVR
 @item -mno-wrap
 This option reject @code{rjmp/rcall} instructions with 8K wrap-around.
 
-@cindex @code{-mrmw} command line option, AVR
+@cindex @code{-mrmw} command-line option, AVR
 @item -mrmw
 Accept Read-Modify-Write (@code{XCH,LAC,LAS,LAT}) instructions.
 
-@cindex @code{-mlink-relax} command line option, AVR
+@cindex @code{-mlink-relax} command-line option, AVR
 @item -mlink-relax
 Enable support for link-time relaxation.  This is now on by default
 and this flag no longer has any effect.
 
-@cindex @code{-mno-link-relax} command line option, AVR
+@cindex @code{-mno-link-relax} command-line option, AVR
 @item -mno-link-relax
 Disable support for link-time relaxation.  The assembler will resolve
 relocations when it can, and may be able to better compress some debug
 information.
 
+@cindex @code{-mgcc-isr} command-line option, AVR
+@item -mgcc-isr
+Enable the @code{__gcc_isr} pseudo instruction.
+
+@cindex @code{-mno-dollar-line-separator} command line option, AVR
+@item -mno-dollar-line-separator
+Do not treat the @code{$} character as a line separator character.
+This is for languages where @code{$} is valid character inside symbol
+names.
+
 @end table
 
 
@@ -181,7 +195,8 @@ control command (@pxref{Preprocessing}).
 @cindex AVR line separator
 
 The @samp{$} character can be used instead of a newline to separate
-statements.
+statements.  Note: the @option{-mno-dollar-line-separator} option
+disables this behaviour.
 
 @node AVR-Regs
 @subsection Register Names
@@ -222,12 +237,12 @@ modifier(relocatable-expression)
 @item lo8
 
 This modifier allows you to use bits 0 through 7 of
-an address expression as 8 bit relocatable expression.
+an address expression as an 8 bit relocatable expression.
 
 @item hi8
 
 This modifier allows you to use bits 7 through 15 of an address expression
-as 8 bit relocatable expression.  This is useful with, for example, the
+as an 8 bit relocatable expression. This is useful with, for example, the
 AVR @samp{ldi} instruction and @samp{lo8} modifier.
 
 For example
@@ -240,7 +255,7 @@ ldi r27, hi8(sym+10)
 @item hh8
 
 This modifier allows you to use bits 16 through 23 of
-an address expression as 8 bit relocatable expression.
+an address expression as an 8 bit relocatable expression.
 Also, can be useful for loading 32 bit constants.
 
 @item hlo8
@@ -250,7 +265,7 @@ Synonym of @samp{hh8}.
 @item hhi8
 
 This modifier allows you to use bits 24 through 31 of
-an expression as 8 bit expression. This is useful with, for example, the
+an expression as an 8 bit expression. This is useful with, for example, the
 AVR @samp{ldi} instruction and @samp{lo8}, @samp{hi8}, @samp{hlo8},
 @samp{hhi8}, modifier.
 
@@ -267,24 +282,33 @@ ldi r29, hhi8(285774925)
 @item pm_lo8
 
 This modifier allows you to use bits 0 through 7 of
-an address expression as 8 bit relocatable expression.
-This modifier useful for addressing data or code from
-Flash/Program memory. The using of @samp{pm_lo8} similar
-to @samp{lo8}.
+an address expression as an 8 bit relocatable expression.
+This modifier is useful for addressing data or code from
+Flash/Program memory by two-byte words. The use of @samp{pm_lo8}
+is similar to @samp{lo8}.
 
 @item pm_hi8
 
 This modifier allows you to use bits 8 through 15 of
-an address expression as 8 bit relocatable expression.
-This modifier useful for addressing data or code from
-Flash/Program memory.
+an address expression as an 8 bit relocatable expression.
+This modifier is useful for addressing data or code from
+Flash/Program memory by two-byte words.
+
+For example, when setting the AVR @samp{Z} register with the @samp{ldi}
+instruction for subsequent use by the @samp{ijmp} instruction:
+
+@smallexample
+ldi r30, pm_lo8(sym)
+ldi r31, pm_hi8(sym)
+ijmp
+@end smallexample
 
 @item pm_hh8
 
 This modifier allows you to use bits 15 through 23 of
-an address expression as 8 bit relocatable expression.
-This modifier useful for addressing data or code from
-Flash/Program memory.
+an address expression as an 8 bit relocatable expression.
+This modifier is useful for addressing data or code from
+Flash/Program memory by two-byte words.
 
 @end table
 
@@ -441,3 +465,60 @@ The following table summarizes the AVR opcodes, and their arguments.
 1001010100011001   eicall
 1001010000011001   eijmp
 @end smallexample
+
+@node AVR Pseudo Instructions
+@section Pseudo Instructions
+
+The only available pseudo-instruction @code{__gcc_isr} can be activated by
+option @option{-mgcc-isr}.
+
+@table @code
+
+@item __gcc_isr 1
+Emit code chunk to be used in avr-gcc ISR prologue.
+It will expand to at most six 1-word instructions, all optional:
+push of @code{tmp_reg}, push of @code{SREG},
+push and clear of @code{zero_reg}, push of @var{Reg}.
+
+@item __gcc_isr 2
+Emit code chunk to be used in an avr-gcc ISR epilogue.
+It will expand to at most five 1-word instructions, all optional: 
+pop of @var{Reg}, pop of @code{zero_reg},
+pop of @code{SREG}, pop of @code{tmp_reg}.
+
+@item __gcc_isr 0, @var{Reg}
+Finish avr-gcc ISR function.  Scan code since the last prologue
+for usage of: @code{SREG}, @code{tmp_reg}, @code{zero_reg}.
+Prologue chunk and epilogue chunks will be replaced by appropriate code
+to save / restore @code{SREG}, @code{tmp_reg}, @code{zero_reg} and @var{Reg}.
+
+@end table
+
+Example input:
+
+@example
+__vector1:
+    __gcc_isr 1
+    lds r24, var
+    inc r24
+    sts var, r24
+    __gcc_isr 2
+    reti
+    __gcc_isr 0, r24
+@end example
+
+Example output:
+
+@example
+00000000 <__vector1>:
+   0:   8f 93           push    r24
+   2:   8f b7           in      r24, 0x3f
+   4:   8f 93           push    r24
+   6:   80 91 60 00     lds     r24, 0x0060     ; 0x800060 <var>
+   a:   83 95           inc     r24
+   c:   80 93 60 00     sts     0x0060, r24     ; 0x800060 <var>
+  10:   8f 91           pop     r24
+  12:   8f bf           out     0x3f, r24
+  14:   8f 91           pop     r24
+  16:   18 95           reti
+@end example