uart.h

Go to the documentation of this file.

#ifndef UART_H
#define UART_H
#include "features.h"

/*
 *  Copyright © 2010-2015, Matthias Urlichs <matthias@urlichs.de>
 *
 *  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 3 of the License, or
 *  (at your option) any later version.
 *
 *  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 (included; see the file LICENSE)
 *  for more details.
 */

/* This code is based on work by: */

/************************************************************************
Title:     Interrupt UART library with receive/transmit circular buffers
Author:    Peter Fleury <pfleury@gmx.ch>   http://jump.to/fleury
File:      not valid see "Extension" 
           ($Id: uart.h,v 1.7.2.1 2003/12/27 20:39:14 peter Exp $)
Software:  AVR-GCC 3.3/3.4
Hardware:  any AVR with built-in UART, tested on AT90S8515 at 4 Mhz and
           ATmega16 at 1.8, 3.6, 4 and 8 MHz
Usage:     see Doxygen manual
Extension: uart_puti, uart_puthex_nibble, uart_puthex_byte 
           by M.Thomas 9/2004
************************************************************************/


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


/*
** constants and macros
*/

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


#ifndef P
#define P(s) ({static const char c[] __attribute__ ((progmem)) = s;c;})
#endif


/* 
** high byte error return code of uart_getc()
*/
#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   */

#ifdef HAVE_UART

/*
** function prototypes
*/

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 *s );

#define uart_puts_P(__s)       uart_puts_p(P(__s))

extern void uart_puti( int i );
extern void uart_putl( long i );

extern void uart_puthex_nibble(const unsigned char b);

extern void uart_puthex_byte(const unsigned char b);
extern void uart_puthex_byte_(const unsigned char b);

extern void uart_puthex_word(const uint16_t b);

#if !defined(HAVE_UART_IRQ) && !defined(HAVE_UART_SYNC)
extern void uart_poll(void);
#else
#define uart_poll() do {} while(0)
#endif

#else // !HAVE_UART

#define uart_init(baud) do {} while(0)
#define uart_getc() UART_NO_DATA
#define uart_putc(data) do {} while(0)
#define uart_puts(s) do {} while(0)
#define uart_puts_p(s) do {} while(0)
#define uart_puts_P(s) do {} while(0)
#define uart_puti(i) do {} while(0)
#define uart_putl(i) do {} while(0)
#define uart_puthex_nibble(b) do {} while(0)
#define uart_puthex_byte(b) do {} while(0)
#define uart_puthex_byte_(b) do {} while(0)
#define uart_puthex_word(b) do {} while(0)
#define uart_poll() do {} while(0)

#endif // !HAVE_UART
#endif // UART_H