Additional notes from <avr/sfr_defs.h>

The <avr/sfr_defs.h> file is included by all of the <avr/ioXXXX.h> files, which use macros defined here to make the special function register definitions look like C variables or simple constants, depending on the _SFR_ASM_COMPAT define. More...

Macros
#define	_SFR_ASM_COMPAT   0
#define	_MMIO_BYTE(mem_addr)   (*(volatile uint8_t *)(mem_addr))
#define	_MMIO_WORD(mem_addr)   (*(volatile uint16_t *)(mem_addr))
#define	_MMIO_DWORD(mem_addr)   (*(volatile uint32_t *)(mem_addr))
#define	__SFR_OFFSET   0x20
#define	_SFR_MEM8(mem_addr)   _MMIO_BYTE(mem_addr)
#define	_SFR_MEM16(mem_addr)   _MMIO_WORD(mem_addr)
#define	_SFR_MEM32(mem_addr)   _MMIO_DWORD(mem_addr)
#define	_SFR_IO8(io_addr)   _MMIO_BYTE((io_addr) + __SFR_OFFSET)
#define	_SFR_IO16(io_addr)   _MMIO_WORD((io_addr) + __SFR_OFFSET)
#define	_SFR_MEM_ADDR(sfr)   ((uint16_t) &(sfr))
#define	_SFR_IO_ADDR(sfr)   (_SFR_MEM_ADDR(sfr) - __SFR_OFFSET)
#define	_SFR_IO_REG_P(sfr)   (_SFR_MEM_ADDR(sfr) < 0x40 + __SFR_OFFSET)
#define	_SFR_ADDR(sfr)   _SFR_MEM_ADDR(sfr)
#define	_SFR_BYTE(sfr)   _MMIO_BYTE(_SFR_ADDR(sfr))
#define	_SFR_WORD(sfr)   _MMIO_WORD(_SFR_ADDR(sfr))
#define	_SFR_DWORD(sfr)   _MMIO_DWORD(_SFR_ADDR(sfr))
#define	_VECTOR(N)   __vector_ ## N

Bit Manipulation
#define	_BV(bit)   (1 << (bit))

IO Register Bit Manipulation
#define	bit_is_set(sfr, bit)   (_SFR_BYTE(sfr) & _BV(bit))
#define	bit_is_clear(sfr, bit)   (!(_SFR_BYTE(sfr) & _BV(bit)))
#define	loop_until_bit_is_set(sfr, bit)   do { } while (bit_is_clear(sfr, bit))
#define	loop_until_bit_is_clear(sfr, bit)   do { } while (bit_is_set(sfr, bit))

Detailed Description

The <avr/sfr_defs.h> file is included by all of the <avr/ioXXXX.h> files, which use macros defined here to make the special function register definitions look like C variables or simple constants, depending on the _SFR_ASM_COMPAT define.

Some examples from <avr/iocanxx.h> to show how to define such macros:

#define PORTA   _SFR_IO8(0x02)
#define EEAR    _SFR_IO16(0x21)
#define UDR0    _SFR_MEM8(0xC6)
#define TCNT3   _SFR_MEM16(0x94)
#define CANIDT  _SFR_MEM32(0xF0)

If _SFR_ASM_COMPAT is not defined, C programs can use names like PORTA directly in C expressions (also on the left side of assignment operators) and GCC will do the right thing (use short I/O instructions if possible). The __SFR_OFFSET definition is not used in any way in this case.

Define _SFR_ASM_COMPAT as 1 to make these names work as simple constants (addresses of the I/O registers). This is necessary when included in preprocessed assembler (*.S) source files, so it is done automatically if ASSEMBLER is defined. By default, all addresses are defined as if they were memory addresses (used in lds/sts instructions). To use these addresses in in/out instructions, you must subtract 0x20 from them.

For more backwards compatibility, insert the following at the start of your old assembler source file:

#define __SFR_OFFSET 0

This automatically subtracts 0x20 from I/O space addresses, but it's a hack, so it is recommended to change your source: wrap such addresses in macros defined here, as shown below. After this is done, the __SFR_OFFSET definition is no longer necessary and can be removed.

Real example - this code could be used in a boot loader that is portable between devices with SPMCR at different addresses.

* <avr/iom163.h>: #define SPMCR _SFR_IO8(0x37)
* <avr/iom128.h>: #define SPMCR _SFR_MEM8(0x68)
* 

#if _SFR_IO_REG_P(SPMCR)
      out     _SFR_IO_ADDR(SPMCR), r24
#else
      sts     _SFR_MEM_ADDR(SPMCR), r24
#endif

You can use the in/out/cbi/sbi/sbic/sbis instructions, without the _SFR_IO_REG_P test, if you know that the register is in the I/O space (as with SREG, for example). If it isn't, the assembler will complain (I/O address out of range 0...0x3f), so this should be fairly safe.

If you do not define __SFR_OFFSET (so it will be 0x20 by default), all special register addresses are defined as memory addresses (so SREG is 0x5f), and (if code size and speed are not important, and you don't like the ugly #if above) you can always use lds/sts to access them. But, this will not work if __SFR_OFFSET != 0x20, so use a different macro (defined only if __SFR_OFFSET == 0x20) for safety:

sts     _SFR_ADDR(SPMCR), r24

In C programs, all 3 combinations of _SFR_ASM_COMPAT and __SFR_OFFSET are supported - the _SFR_ADDR(SPMCR) macro can be used to get the address of the SPMCR register (0x57 or 0x68 depending on device).

Macro Definition Documentation

_BV

#define _BV

(

bit

)

(1 << (bit))

#include <avr/io.h> 

Converts a bit number into a byte value.

Note

The bit shift is performed by the compiler which then inserts the result into the code. Thus, there is no run-time overhead when using _BV().

bit_is_clear

#define bit_is_clear	(		sfr,
			bit
	)		(!(_SFR_BYTE(sfr) & _BV(bit)))

#include <avr/io.h> 

Test whether bit bit in IO register sfr is clear. This will return non-zero if the bit is clear, and a 0 if the bit is set.

bit_is_set

#define bit_is_set	(		sfr,
			bit
	)		(_SFR_BYTE(sfr) & _BV(bit))

#include <avr/io.h> 

Test whether bit bit in IO register sfr is set. This will return a 0 if the bit is clear, and non-zero if the bit is set.

loop_until_bit_is_clear

#define loop_until_bit_is_clear	(		sfr,
			bit
	)		do { } while (bit_is_set(sfr, bit))

#include <avr/io.h> 

Wait until bit bit in IO register sfr is clear.

loop_until_bit_is_set

#define loop_until_bit_is_set	(		sfr,
			bit
	)		do { } while (bit_is_clear(sfr, bit))

#include <avr/io.h> 

Wait until bit bit in IO register sfr is set.