Interrupt UART library using the built-in UART with transmit and receive circular buffers. More...

Macros
#define	USART0_ENABLED

#define	UART_RX0_BUFFER_SIZE 128

#define	UART_RX1_BUFFER_SIZE 128

#define	UART_RX2_BUFFER_SIZE 128

#define	UART_RX3_BUFFER_SIZE 128

#define	UART_TX0_BUFFER_SIZE 128

#define	UART_TX1_BUFFER_SIZE 128

#define	UART_TX2_BUFFER_SIZE 128

#define	UART_TX3_BUFFER_SIZE 128

#define	UART_BAUD_SELECT(baudRate, xtalCpu) (((xtalCpu)+8UL(baudRate))/(16UL(baudRate))-1UL)
	UART Baudrate Expression. More...

#define	UART_BAUD_SELECT_DOUBLE_SPEED(baudRate, xtalCpu) ((((xtalCpu)+4UL(baudRate))/(8UL(baudRate))-1)\|0x8000)
	UART Baudrate Expression for ATmega double speed mode. More...

#define	UART_FRAME_ERROR 0x0800

#define	UART_OVERRUN_ERROR 0x0400

#define	UART_BUFFER_OVERFLOW 0x0200

#define	UART_NO_DATA 0x0100

#define	uart_init(b) uart0_init(b)
	Macro to initialize USART0 (only available on selected ATmegas) More...

#define	uart_getc() uart0_getc()
	Macro to get received byte of USART0 from ringbuffer. (only available on selected ATmega) More...

#define	uart_peek() uart0_peek()
	Macro to peek at next byte in USART0 ringbuffer.

#define	uart_putc(d) uart0_putc(d)
	Macro to put byte to ringbuffer for transmitting via USART0 (only available on selected ATmega) More...

#define	uart_puts(s) uart0_puts(s)
	Macro to put string to ringbuffer for transmitting via USART0 (only available on selected ATmega) More...

#define	uart_puts_p(s) uart0_puts_p(s)
	Macro to put string from program memory to ringbuffer for transmitting via USART0 (only available on selected ATmega) More...

#define	uart_available() uart0_available()
	Macro to return number of bytes waiting in the receive buffer of USART0. More...

#define	uart_flush() uart0_flush()
	Macro to flush bytes waiting in receive buffer of USART0. More...

#define	uart_puts_P(__s) uart0_puts_p(PSTR(__s))
	Macro to automatically put a string constant into program memory. More...

#define	uart0_puts_P(__s) uart0_puts_p(PSTR(__s))
	Macro to automatically put a string constant into program memory.

#define	uart1_puts_P(__s) uart1_puts_p(PSTR(__s))
	Macro to automatically put a string constant into program memory of USART1. More...

#define	uart2_puts_P(__s) uart2_puts_p(PSTR(__s))
	Macro to automatically put a string constant into program memory of USART2. More...

#define	uart3_puts_P(__s) uart3_puts_p(PSTR(__s))
	Macro to automatically put a string constant into program memory of USART3. More...

Functions
void	uart0_init (uint16_t baudrate)
	Initialize UART and set baudrate. More...

uint16_t	uart0_getc (void)
	Get received byte from ringbuffer. More...

uint16_t	uart0_peek (void)
	Peek at next byte in ringbuffer. More...

void	uart0_putc (uint8_t data)
	Put byte to ringbuffer for transmitting via UART. More...

void	uart0_puts (const char *s)
	Put string to ringbuffer for transmitting via UART. More...

void	uart0_puts_p (const char *s)
	Put string from program memory to ringbuffer for transmitting via UART. More...

uint16_t	uart0_available (void)
	Return number of bytes waiting in the receive buffer. More...

void	uart0_flush (void)
	Flush bytes waiting in receive buffer.

void	uart1_init (uint16_t baudrate)
	Initialize USART1 (only available on selected ATmegas) More...

uint16_t	uart1_getc (void)
	Get received byte of USART1 from ringbuffer. (only available on selected ATmega) More...

uint16_t	uart1_peek (void)
	Peek at next byte in USART1 ringbuffer.

void	uart1_putc (uint8_t data)
	Put byte to ringbuffer for transmitting via USART1 (only available on selected ATmega) More...

void	uart1_puts (const char *s)
	Put string to ringbuffer for transmitting via USART1 (only available on selected ATmega) More...

void	uart1_puts_p (const char *s)
	Put string from program memory to ringbuffer for transmitting via USART1 (only available on selected ATmega) More...

uint16_t	uart1_available (void)
	Return number of bytes waiting in the receive buffer of USART1.

void	uart1_flush (void)
	Flush bytes waiting in receive buffer of USART1.

void	uart2_init (uint16_t baudrate)
	Initialize USART2 (only available on selected ATmegas) More...

uint16_t	uart2_getc (void)
	Get received byte of USART2 from ringbuffer. (only available on selected ATmega) More...

uint16_t	uart2_peek (void)
	Peek at next byte in USART2 ringbuffer.

void	uart2_putc (uint8_t data)
	Put byte to ringbuffer for transmitting via USART2 (only available on selected ATmega) More...

void	uart2_puts (const char *s)
	Put string to ringbuffer for transmitting via USART2 (only available on selected ATmega) More...

void	uart2_puts_p (const char *s)
	Put string from program memory to ringbuffer for transmitting via USART2 (only available on selected ATmega) More...

uint16_t	uart2_available (void)
	Return number of bytes waiting in the receive buffer of USART2.

void	uart2_flush (void)
	Flush bytes waiting in receive buffer of USART2.

void	uart3_init (uint16_t baudrate)
	Initialize USART3 (only available on selected ATmegas) More...

uint16_t	uart3_getc (void)
	Get received byte of USART3 from ringbuffer. (only available on selected ATmega) More...

uint16_t	uart3_peek (void)
	Peek at next byte in USART3 ringbuffer.

void	uart3_putc (uint8_t data)
	Put byte to ringbuffer for transmitting via USART3 (only available on selected ATmega) More...

void	uart3_puts (const char *s)
	Put string to ringbuffer for transmitting via USART3 (only available on selected ATmega) More...

void	uart3_puts_p (const char *s)
	Put string from program memory to ringbuffer for transmitting via USART3 (only available on selected ATmega) More...

uint16_t	uart3_available (void)
	Return number of bytes waiting in the receive buffer of USART3.

void	uart3_flush (void)
	Flush bytes waiting in receive buffer of USART3.

Detailed Description

Interrupt UART library using the built-in UART with transmit and receive circular buffers.

#include <uart.h>

See also: README.md

This library can be used to transmit and receive data through the built in UART.

An interrupt is generated when the UART has finished transmitting or receiving a byte. The interrupt handling routines use circular buffers for buffering received and transmitted data.

The UART_RXn_BUFFER_SIZE and UART_TXn_BUFFER_SIZE constants define the size of the circular buffers in bytes. Note that these constants must be a power of 2.

You need to define these buffer sizes as a symbol in your compiler settings or in uart.h

See README.md for more detailed information. Especially that relating to symbols: USARTn_ENABLED and USARTn_LARGE_BUFFER

Author: Andy Gock andy@.nosp@m.gock.nosp@m..net

Note: Based on Atmel Application Note AVR306 and original library by Peter Fleury and Tim Sharpe.

Macro Definition Documentation

§ uart1_puts_P

#define uart1_puts_P ( __s ) uart1_puts_p(PSTR(__s))

Macro to automatically put a string constant into program memory of USART1.

See also: uart1_puts_p

Definition at line 369 of file uart.h.

§ uart2_puts_P

#define uart2_puts_P ( __s ) uart2_puts_p(PSTR(__s))

Macro to automatically put a string constant into program memory of USART2.

See also: uart2_puts_p

Definition at line 397 of file uart.h.

§ uart3_puts_P

#define uart3_puts_P ( __s ) uart3_puts_p(PSTR(__s))

Macro to automatically put a string constant into program memory of USART3.

See also: uart3_puts_p

Definition at line 425 of file uart.h.

§ uart_available

#define uart_available ( ) uart0_available()

Macro to return number of bytes waiting in the receive buffer of USART0.

See also: uart0_available

Definition at line 224 of file uart.h.

§ UART_BAUD_SELECT

#define UART_BAUD_SELECT	(	baudRate,
		xtalCpu
	)	(((xtalCpu)+8UL(baudRate))/(16UL(baudRate))-1UL)

UART Baudrate Expression.

Parameters

xtalCpu	system clock in Mhz, e.g. 4000000L for 4Mhz
baudRate	baudrate in bps, e.g. 1200, 2400, 9600

Definition at line 169 of file uart.h.

§ UART_BAUD_SELECT_DOUBLE_SPEED

#define UART_BAUD_SELECT_DOUBLE_SPEED	(	baudRate,
		xtalCpu
	)	((((xtalCpu)+4UL(baudRate))/(8UL(baudRate))-1)\|0x8000)

UART Baudrate Expression for ATmega double speed mode.

Parameters

xtalCpu	system clock in Mhz, e.g. 4000000L for 4Mhz
baudRate	baudrate in bps, e.g. 1200, 2400, 9600

Definition at line 175 of file uart.h.

§ UART_BUFFER_OVERFLOW

#define UART_BUFFER_OVERFLOW 0x0200

receive ringbuffer overflow

Definition at line 200 of file uart.h.

§ uart_flush

#define uart_flush ( ) uart0_flush()

Macro to flush bytes waiting in receive buffer of USART0.

See also: uart0_flush

Definition at line 227 of file uart.h.

§ UART_FRAME_ERROR

#define UART_FRAME_ERROR 0x0800

Framing Error by UART

Definition at line 198 of file uart.h.

§ uart_getc

#define uart_getc ( ) uart0_getc()

Macro to get received byte of USART0 from ringbuffer. (only available on selected ATmega)

See also: uart0_getc

Definition at line 209 of file uart.h.

§ uart_init

#define uart_init ( b ) uart0_init(b)

Macro to initialize USART0 (only available on selected ATmegas)

See also: uart0_init

Definition at line 206 of file uart.h.

§ UART_NO_DATA

#define UART_NO_DATA 0x0100

no receive data available

Definition at line 201 of file uart.h.

§ UART_OVERRUN_ERROR

#define UART_OVERRUN_ERROR 0x0400

Overrun condition by UART

Definition at line 199 of file uart.h.

§ uart_putc

#define uart_putc ( d ) uart0_putc(d)

Macro to put byte to ringbuffer for transmitting via USART0 (only available on selected ATmega)

See also: uart0_putc

Definition at line 215 of file uart.h.

§ uart_puts

#define uart_puts ( s ) uart0_puts(s)

Macro to put string to ringbuffer for transmitting via USART0 (only available on selected ATmega)

See also: uart0_puts

Definition at line 218 of file uart.h.

§ uart_puts_p

#define uart_puts_p ( s ) uart0_puts_p(s)

Macro to put string from program memory to ringbuffer for transmitting via USART0 (only available on selected ATmega)

See also: uart0_puts_p

Definition at line 221 of file uart.h.

§ uart_puts_P

#define uart_puts_P ( __s ) uart0_puts_p(PSTR(__s))

Macro to automatically put a string constant into program memory.

Parameters

__s	string in program memory

Definition at line 333 of file uart.h.

§ UART_RX0_BUFFER_SIZE

#define UART_RX0_BUFFER_SIZE 128

Size of the circular receive buffer, must be power of 2

Definition at line 104 of file uart.h.

§ UART_RX1_BUFFER_SIZE

#define UART_RX1_BUFFER_SIZE 128

Size of the circular receive buffer, must be power of 2

Definition at line 107 of file uart.h.

§ UART_RX2_BUFFER_SIZE

#define UART_RX2_BUFFER_SIZE 128

Size of the circular receive buffer, must be power of 2

Definition at line 110 of file uart.h.

§ UART_RX3_BUFFER_SIZE

#define UART_RX3_BUFFER_SIZE 128

Size of the circular receive buffer, must be power of 2

Definition at line 113 of file uart.h.

§ UART_TX0_BUFFER_SIZE

#define UART_TX0_BUFFER_SIZE 128

Size of the circular transmit buffer, must be power of 2

Definition at line 117 of file uart.h.

§ UART_TX1_BUFFER_SIZE

#define UART_TX1_BUFFER_SIZE 128

Size of the circular transmit buffer, must be power of 2

Definition at line 120 of file uart.h.

§ UART_TX2_BUFFER_SIZE

#define UART_TX2_BUFFER_SIZE 128

Size of the circular transmit buffer, must be power of 2

Definition at line 123 of file uart.h.

§ UART_TX3_BUFFER_SIZE

#define UART_TX3_BUFFER_SIZE 128

Size of the circular transmit buffer, must be power of 2

Definition at line 126 of file uart.h.

§ USART0_ENABLED

#define USART0_ENABLED

Enable USART0

Definition at line 95 of file uart.h.

Function Documentation

§ uart0_available()

uint16_t uart0_available ( void )

Return number of bytes waiting in the receive buffer.

Returns: bytes waiting in the receive buffer

§ uart0_getc()

uint16_t uart0_getc ( void )

Get received byte from ringbuffer.

Returns in the lower byte the received character and in the higher byte the last receive error. UART_NO_DATA is returned when no data is available.

Returns

lower byte: received byte from ringbuffer

higher byte: last receive status

0 successfully received data from UART
UART_NO_DATA
no receive data available
UART_BUFFER_OVERFLOW
Receive ringbuffer overflow. We are not reading the receive buffer fast enough, one or more received character have been dropped
UART_OVERRUN_ERROR
Overrun condition by UART. A character already present in the UART UDR register was not read by the interrupt handler before the next character arrived, one or more received characters have been dropped.
UART_FRAME_ERROR
Framing Error by UART

§ uart0_init()

void uart0_init ( uint16_t baudrate )

Initialize UART and set baudrate.

Parameters

baudrate Specify baudrate using macro UART_BAUD_SELECT()

Returns: none

§ uart0_peek()

uint16_t uart0_peek ( void )

Peek at next byte in ringbuffer.

Returns the next byte (character) of incoming UART data without removing it from the internal ring buffer. That is, successive calls to uartN_peek() will return the same character, as will the next call to uartN_getc().

UART_NO_DATA is returned when no data is available.

Returns

lower byte: next byte in ringbuffer

higher byte: last receive status

0 successfully received data from UART
UART_NO_DATA
no receive data available
UART_BUFFER_OVERFLOW
Receive ringbuffer overflow. We are not reading the receive buffer fast enough, one or more received character have been dropped
UART_OVERRUN_ERROR
Overrun condition by UART. A character already present in the UART UDR register was not read by the interrupt handler before the next character arrived, one or more received characters have been dropped.
UART_FRAME_ERROR
Framing Error by UART

§ uart0_putc()

void uart0_putc ( uint8_t data )

Put byte to ringbuffer for transmitting via UART.

Parameters

data	byte to be transmitted

Returns: none

§ uart0_puts()

void uart0_puts ( const char * s )

Put string to ringbuffer for transmitting via UART.

The string is buffered by the uart library in a circular buffer and one character at a time is transmitted to the UART using interrupts. Blocks if it can not write the whole string into the circular buffer.

Parameters

s	string to be transmitted

Returns: none

§ uart0_puts_p()

void uart0_puts_p ( const char * s )

Put string from program memory to ringbuffer for transmitting via UART.

The string is buffered by the uart library in a circular buffer and one character at a time is transmitted to the UART using interrupts. Blocks if it can not write the whole string into the circular buffer.

Parameters

s	program memory string to be transmitted

Returns: none

See also: uart0_puts_P

§ uart1_getc()

uint16_t uart1_getc ( void )

Get received byte of USART1 from ringbuffer. (only available on selected ATmega)

See also: uart_getc

§ uart1_init()

void uart1_init ( uint16_t baudrate )

Initialize USART1 (only available on selected ATmegas)

See also: uart_init

§ uart1_putc()

void uart1_putc ( uint8_t data )

Put byte to ringbuffer for transmitting via USART1 (only available on selected ATmega)

See also: uart_putc

§ uart1_puts()

void uart1_puts ( const char * s )

Put string to ringbuffer for transmitting via USART1 (only available on selected ATmega)

See also: uart_puts

§ uart1_puts_p()

void uart1_puts_p ( const char * s )

Put string from program memory to ringbuffer for transmitting via USART1 (only available on selected ATmega)

See also: uart_puts_p

§ uart2_getc()

uint16_t uart2_getc ( void )

Get received byte of USART2 from ringbuffer. (only available on selected ATmega)

See also: uart_getc

§ uart2_init()

void uart2_init ( uint16_t baudrate )

Initialize USART2 (only available on selected ATmegas)

See also: uart_init

§ uart2_putc()

void uart2_putc ( uint8_t data )

Put byte to ringbuffer for transmitting via USART2 (only available on selected ATmega)

See also: uart_putc

§ uart2_puts()

void uart2_puts ( const char * s )

Put string to ringbuffer for transmitting via USART2 (only available on selected ATmega)

See also: uart_puts

§ uart2_puts_p()

void uart2_puts_p ( const char * s )

Put string from program memory to ringbuffer for transmitting via USART2 (only available on selected ATmega)

See also: uart_puts_p

§ uart3_getc()

uint16_t uart3_getc ( void )

Get received byte of USART3 from ringbuffer. (only available on selected ATmega)

See also: uart_getc

§ uart3_init()

void uart3_init ( uint16_t baudrate )

Initialize USART3 (only available on selected ATmegas)

See also: uart_init

§ uart3_putc()

void uart3_putc ( uint8_t data )

Put byte to ringbuffer for transmitting via USART3 (only available on selected ATmega)

See also: uart_putc

§ uart3_puts()

void uart3_puts ( const char * s )

Put string to ringbuffer for transmitting via USART3 (only available on selected ATmega)

See also: uart_puts

§ uart3_puts_p()

void uart3_puts_p ( const char * s )

Put string from program memory to ringbuffer for transmitting via USART3 (only available on selected ATmega)

See also: uart_puts_p

Macros

Functions

Detailed Description

Macro Definition Documentation

§ uart1_puts_P

§ uart2_puts_P

§ uart3_puts_P

§ uart_available

§ UART_BAUD_SELECT

§ UART_BAUD_SELECT_DOUBLE_SPEED

§ UART_BUFFER_OVERFLOW

§ uart_flush

§ UART_FRAME_ERROR

§ uart_getc

§ uart_init

§ UART_NO_DATA

§ UART_OVERRUN_ERROR

§ uart_putc

§ uart_puts

§ uart_puts_p

§ uart_puts_P

§ UART_RX0_BUFFER_SIZE

§ UART_RX1_BUFFER_SIZE

§ UART_RX2_BUFFER_SIZE

§ UART_RX3_BUFFER_SIZE

§ UART_TX0_BUFFER_SIZE

§ UART_TX1_BUFFER_SIZE

§ UART_TX2_BUFFER_SIZE

§ UART_TX3_BUFFER_SIZE

§ USART0_ENABLED

Function Documentation

§ uart0_available()

§ uart0_getc()

§ uart0_init()

§ uart0_peek()

§ uart0_putc()

§ uart0_puts()

§ uart0_puts_p()

§ uart1_getc()

§ uart1_init()

§ uart1_putc()

§ uart1_puts()

§ uart1_puts_p()

§ uart2_getc()

§ uart2_init()

§ uart2_putc()

§ uart2_puts()

§ uart2_puts_p()

§ uart3_getc()

§ uart3_init()

§ uart3_putc()

§ uart3_puts()

§ uart3_puts_p()