arduinisten/arduino-0018-windows/hardware/tools/avr/doc/avr-libc/man/man3/assembler.3

.TH "assembler" 3 "4 Dec 2008" "Version 1.6.4" "avr-libc" \" -*- nroff -*-
.ad l
.nh
.SH NAME
assembler \- avr-libc and assembler programs 
.SH "Introduction"
.PP
There might be several reasons to write code for AVR microcontrollers using plain assembler source code. Among them are:
.PP
.IP "\(bu" 2
Code for devices that do not have RAM and are thus not supported by the C compiler.
.IP "\(bu" 2
Code for very time-critical applications.
.IP "\(bu" 2
Special tweaks that cannot be done in C.
.PP
.PP
Usually, all but the first could probably be done easily using the \fBinline assembler\fP facility of the compiler.
.PP
Although avr-libc is primarily targeted to support programming AVR microcontrollers using the C (and C++) language, there's limited support for direct assembler usage as well. The benefits of it are:
.PP
.IP "\(bu" 2
Use of the C preprocessor and thus the ability to use the same symbolic constants that are available to C programs, as well as a flexible macro concept that can use any valid C identifier as a macro (whereas the assembler's macro concept is basically targeted to use a macro in place of an assembler instruction).
.IP "\(bu" 2
Use of the runtime framework like automatically assigning interrupt vectors. For devices that have RAM, \fBinitializing the RAM variables\fP can also be utilized.
.PP
.SH "Invoking the compiler"
.PP
For the purpose described in this document, the assembler and linker are usually not invoked manually, but rather using the C compiler frontend (\fCavr-gcc\fP) that in turn will call the assembler and linker as required.
.PP
This approach has the following advantages:
.PP
.IP "\(bu" 2
There is basically only one program to be called directly, \fCavr-gcc\fP, regardless of the actual source language used.
.IP "\(bu" 2
The invokation of the C preprocessor will be automatic, and will include the appropriate options to locate required include files in the filesystem.
.IP "\(bu" 2
The invokation of the linker will be automatic, and will include the appropriate options to locate additional libraries as well as the application start-up code (\fCcrt\fP\fIXXX\fP\fC.o\fP) and linker script.
.PP
.PP
Note that the invokation of the C preprocessor will be automatic when the filename provided for the assembler file ends in \fC\fP.S (the capital letter 's'). This would even apply to operating systems that use case-insensitive filesystems since the actual decision is made based on the case of the filename suffix given on the command-line, not based on the actual filename from the file system.
.PP
Alternatively, the language can explicitly be specified using the \fC-x assembler-with-cpp\fP option.
.SH "Example program"
.PP
The following annotated example features a simple 100 kHz square wave generator using an AT90S1200 clocked with a 10.7 MHz crystal. Pin PD6 will be used for the square wave output.
.PP
.PP
.nf
#include <avr/io.h>             ; Note [1]

work    =       16              ; Note [2]
tmp     =       17

inttmp  =       19

intsav  =       0

SQUARE  =       PD6             ; Note [3]

                                ; Note [4]:
tmconst= 10700000 / 200000      ; 100 kHz => 200000 edges/s
fuzz=   8                       ; # clocks in ISR until TCNT0 is set

        .section .text

        .global main                            ; Note [5]
main:
        rcall   ioinit
1:
        rjmp    1b                              ; Note [6]

        .global TIMER0_OVF_vect                 ; Note [7]
TIMER0_OVF_vect:
        ldi     inttmp, 256 - tmconst + fuzz
        out     _SFR_IO_ADDR(TCNT0), inttmp     ; Note [8]

        in      intsav, _SFR_IO_ADDR(SREG)      ; Note [9]

        sbic    _SFR_IO_ADDR(PORTD), SQUARE
        rjmp    1f
        sbi     _SFR_IO_ADDR(PORTD), SQUARE
        rjmp    2f
1:      cbi     _SFR_IO_ADDR(PORTD), SQUARE
2:

        out     _SFR_IO_ADDR(SREG), intsav
        reti

ioinit:
        sbi     _SFR_IO_ADDR(DDRD), SQUARE

        ldi     work, _BV(TOIE0)
        out     _SFR_IO_ADDR(TIMSK), work

        ldi     work, _BV(CS00)         ; tmr0:  CK/1
        out     _SFR_IO_ADDR(TCCR0), work

        ldi     work, 256 - tmconst
        out     _SFR_IO_ADDR(TCNT0), work

        sei

        ret

        .global __vector_default                ; Note [10]
__vector_default:
        reti

        .end
.fi
.PP
.PP
\fBNote [1]\fP.RS 4

.RE
.PP
As in C programs, this includes the central processor-specific file containing the IO port definitions for the device. Note that not all include files can be included into assembler sources.
.PP
\fBNote [2]\fP.RS 4

.RE
.PP
Assignment of registers to symbolic names used locally. Another option would be to use a C preprocessor macro instead:
.PP
.PP
.nf
 #define work 16 
.fi
.PP
.PP
\fBNote [3]\fP.RS 4

.RE
.PP
Our bit number for the square wave output. Note that the right-hand side consists of a CPP macro which will be substituted by its value (6 in this case) before actually being passed to the assembler.
.PP
\fBNote [4]\fP.RS 4

.RE
.PP
The assembler uses integer operations in the host-defined integer size (32 bits or longer) when evaluating expressions. This is in contrast to the C compiler that uses the C type \fCint\fP by default in order to calculate constant integer expressions. 
.br
 In order to get a 100 kHz output, we need to toggle the PD6 line 200000 times per second. Since we use timer 0 without any prescaling options in order to get the desired frequency and accuracy, we already run into serious timing considerations: while accepting and processing the timer overflow interrupt, the timer already continues to count. When pre-loading the \fCTCCNT0\fP register, we therefore have to account for the number of clock cycles required for interrupt acknowledge and for the instructions to reload \fCTCCNT0\fP (4 clock cycles for interrupt acknowledge, 2 cycles for the jump from the interrupt vector, 2 cycles for the 2 instructions that reload \fCTCCNT0\fP). This is what the constant \fCfuzz\fP is for.
.PP
\fBNote [5]\fP.RS 4

.RE
.PP
External functions need to be declared to be \fC\fP.global. \fCmain\fP is the application entry point that will be jumped to from the ininitalization routine in \fCcrts1200.o\fP.
.PP
\fBNote [6]\fP.RS 4

.RE
.PP
The main loop is just a single jump back to itself. Square wave generation itself is completely handled by the timer 0 overflow interrupt service. A \fCsleep\fP instruction (using idle mode) could be used as well, but probably would not conserve much energy anyway since the interrupt service is executed quite frequently.
.PP
\fBNote [7]\fP.RS 4

.RE
.PP
Interrupt functions can get the \fBusual names\fP that are also available to C programs. The linker will then put them into the appropriate interrupt vector slots. Note that they must be declared \fC\fP.global in order to be acceptable for this purpose. This will only work if \fC<\fBavr/io.h\fP>\fP has been included. Note that the assembler or linker have no chance to check the correct spelling of an interrupt function, so it should be double-checked. (When analyzing the resulting object file using \fCavr-objdump\fP or \fCavr-nm\fP, a name like \fC__vector_\fIN\fP\fP should appear, with \fIN\fP being a small integer number.)
.PP
\fBNote [8]\fP.RS 4

.RE
.PP
As explained in the section about \fBspecial function registers\fP, the actual IO port address should be obtained using the macro \fC_SFR_IO_ADDR\fP. (The AT90S1200 does not have RAM thus the memory-mapped approach to access the IO registers is not available. It would be slower than using \fCin\fP / \fCout\fP instructions anyway.) 
.br
 Since the operation to reload \fCTCCNT0\fP is time-critical, it is even performed before saving \fCSREG\fP. Obviously, this requires that the instructions involved would not change any of the flag bits in \fCSREG\fP.
.PP
 
.PP
\fBNote [9]\fP.RS 4

.RE
.PP
Interrupt routines must not clobber the global CPU state. Thus, it is usually necessary to save at least the state of the flag bits in \fCSREG\fP. (Note that this serves as an example here only since actually, all the following instructions would not modify \fCSREG\fP either, but that's not commonly the case.) 
.br
 Also, it must be made sure that registers used inside the interrupt routine do not conflict with those used outside. In the case of a RAM-less device like the AT90S1200, this can only be done by agreeing on a set of registers to be used exclusively inside the interrupt routine; there would not be any other chance to 'save' a register anywhere. 
.br
 If the interrupt routine is to be linked together with C modules, care must be taken to follow the \fBregister usage guidelines\fP imposed by the C compiler. Also, any register modified inside the interrupt sevice needs to be saved, usually on the stack.
.PP
\fBNote [10]\fP.RS 4

.RE
.PP
As explained in \fBInterrupts\fP, a global 'catch-all' interrupt handler that gets all unassigned interrupt vectors can be installed using the name \fC__vector_default\fP. This must be \fC\fP.global, and obviously, should end in a \fCreti\fP instruction. (By default, a jump to location 0 would be implied instead.)
.SH "Pseudo-ops and operators"
.PP
The available pseudo-ops in the assembler are described in the GNU assembler (gas) manual. The manual can be found online as part of the current binutils release under http://sources.redhat.com/binutils/.
.PP
As gas comes from a Unix origin, its pseudo-op and overall assembler syntax is slightly different than the one being used by other assemblers. Numeric constants follow the C notation (prefix \fC0x\fP for hexadecimal constants), expressions use a C-like syntax.
.PP
Some common pseudo-ops include:
.PP
.IP "\(bu" 2
\fC\fP.byte allocates single byte constants
.PP
.PP
.IP "\(bu" 2
\fC\fP.ascii allocates a non-terminated string of characters
.PP
.PP
.IP "\(bu" 2
\fC\fP.asciz allocates a \\0-terminated string of characters (C string)
.PP
.PP
.IP "\(bu" 2
\fC\fP.data switches to the .data section (initialized RAM variables)
.PP
.PP
.IP "\(bu" 2
\fC\fP.text switches to the .text section (code and ROM constants)
.PP
.PP
.IP "\(bu" 2
\fC\fP.set declares a symbol as a constant expression (identical to \fC\fP.equ)
.PP
.PP
.IP "\(bu" 2
\fC\fP.global (or \fC\fP.globl) declares a public symbol that is visible to the linker (e. g. function entry point, global variable)
.PP
.PP
.IP "\(bu" 2
\fC\fP.extern declares a symbol to be externally defined; this is effectively a comment only, as gas treats all undefined symbols it encounters as globally undefined anyway
.PP
.PP
Note that \fC\fP.org is available in gas as well, but is a fairly pointless pseudo-op in an assembler environment that uses relocatable object files, as it is the linker that determines the final position of some object in ROM or RAM.
.PP
Along with the architecture-independent standard operators, there are some AVR-specific operators available which are unfortunately not yet described in the official documentation. The most notable operators are:
.PP
.IP "\(bu" 2
\fClo8\fP Takes the least significant 8 bits of a 16-bit integer
.PP
.PP
.IP "\(bu" 2
\fChi8\fP Takes the most significant 8 bits of a 16-bit integer
.PP
.PP
.IP "\(bu" 2
\fCpm\fP Takes a program-memory (ROM) address, and converts it into a RAM address. This implies a division by 2 as the AVR handles ROM addresses as 16-bit words (e.g. in an \fCIJMP\fP or \fCICALL\fP instruction), and can also handle relocatable symbols on the right-hand side.
.PP
.PP
Example: 
.PP
.nf

	ldi	r24, lo8(pm(somefunc))
	ldi	r25, hi8(pm(somefunc))
	call	something

.fi
.PP
.PP
This passes the address of function \fCsomefunc\fP as the first parameter to function \fCsomething\fP.