softuart.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*
* Software UART for ATtiny processors
*---------------------------------------------------------------------------*
* 14-Apr-2014 ShaneG
*
* Provides an implementation of a UART for serial communications. Includes
* some formatted output utility functions and debug output support.
*--------------------------------------------------------------------------*/
#ifndef __SOFTUART_H
#define __SOFTUART_H

//--- Required definitions
#include <stdint.h>
#include <avr/pgmspace.h>

#ifdef __cplusplus
extern "C" {
#endif

//---------------------------------------------------------------------------
// Core operations
//---------------------------------------------------------------------------

void uartInit();

void uartSend(char ch);

uint8_t uartAvail();

char uartRecv();

//---------------------------------------------------------------------------
// Basic output for data types.
//---------------------------------------------------------------------------

void uartPrint(const char *cszString);

void uartPrintP(const char *cszString);

void uartInt(uint16_t value);

void uartHex(uint16_t value);

//---------------------------------------------------------------------------
// Formatted output
//---------------------------------------------------------------------------

void uartFormat(const char *cszString, ...);

void uartFormatP(const char *cszString, ...);

//---------------------------------------------------------------------------
// Debugging output support (requires formatted print functions)
//---------------------------------------------------------------------------

#if defined(DEBUG)
#  define PRINT(msg)       uartPrintP(PSTR("DEBUG: ")), uartPrintP(PSTR(msg))
#  define PRINTF(fmt, ...) uartPrintP(PSTR("DEBUG: ")), uartFormatP(PSTR(fmt), __VA_ARGS__)
#else
#  define PRINT(msg)
#  define PRINTF(fmt, ...)
#endif

#ifdef __cplusplus
}
#endif

#endif /* __SOFTUART_H */