uart.h

Go to the documentation of this file.

#ifndef UART_H
#define UART_H
/************************************************************************
\file uart.h
\brief Interrupt UART library with receive/transmit circular buffers
\author Peter Fleury <pfleury@gmx.ch>   http://jump.to/fleury
\version 1.8.2.1
\date 2007-07-01

Software: AVR-GCC 4.1, AVR Libc 1.4<br>
Hardware: any AVR with built-in UART, tested on AT90S8515 & ATmega8 at 4 Mhz<br>
License:  GNU General Public License<br>
Usage:    see Doxygen manual<br>
<br>
LICENSE:<br>
    Copyright (C) 2006 Peter Fleury<br>
<br>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    any later version.<br>
<br>
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

************************************************************************/

#if (__GNUC__ * 100 + __GNUC_MINOR__) < 304
#error "This library requires AVR-GCC 3.4 or later, update to newer AVR-GCC compiler !"
#endif


#define UART_BAUD_SELECT(baudRate,xtalCpu) ((xtalCpu)/((baudRate)*16l)-1)

#define UART_BAUD_SELECT_DOUBLE_SPEED(baudRate,xtalCpu) (((xtalCpu)/((baudRate)*8l)-1)|0x8000)


#ifndef UART_RX_BUFFER_SIZE
#define UART_RX_BUFFER_SIZE 64
#endif

#ifndef UART_TX_BUFFER_SIZE
#define UART_TX_BUFFER_SIZE 64
#endif

#if ( (UART_RX_BUFFER_SIZE+UART_TX_BUFFER_SIZE) >= (RAMEND-0x60 ) )
#error "size of UART_RX_BUFFER_SIZE + UART_TX_BUFFER_SIZE larger than size of SRAM"
#endif

#define UART_FRAME_ERROR      0x0800              /* Framing Error by UART       */
#define UART_OVERRUN_ERROR    0x0400              /* Overrun condition by UART   */
#define UART_BUFFER_OVERFLOW  0x0200              /* receive ringbuffer overflow */
#define UART_NO_DATA          0x0100              /* no receive data available   */


extern void uart_init(unsigned int baudrate);


extern unsigned int uart_getc(void);


extern void uart_putc(unsigned char data);


extern void uart_puts(const char *s );


extern void uart_puts_p(const char *progmem_s );

#define uart_puts_P(__s)       uart_puts_p(PSTR(__s))



extern void uart1_init(unsigned int baudrate);
extern unsigned int uart1_getc(void);
extern void uart1_putc(unsigned char data);
extern void uart1_puts(const char *s );
extern void uart1_puts_p(const char *s );
#define uart1_puts_P(__s)       uart1_puts_p(PSTR(__s))

#endif // UART_H