avr/uart
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Ran clang-format

Browse Source
This commit is contained in:
BlackMark 2019-07-30 20:29:15 +02:00
parent 470eb06345
commit c03196493a
2 changed files with 538 additions and 577 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1018
uart.cpp
View File

File diff suppressed because it is too large Load Diff

97
uart.h
View File

@ -20,17 +20,17 @@ LICENSE:
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
************************************************************************/ ************************************************************************/
/** /**
* @file * @file
* @defgroup pfleury_uart UART Library <uart.h> * @defgroup pfleury_uart UART Library <uart.h>
* @code #include <uart.h> @endcode * @code #include <uart.h> @endcode
*
* @brief Interrupt UART library using the built-in UART with transmit and receive circular buffers.
* *
* This library can be used to transmit and receive data through the built in UART. * @brief Interrupt UART library using the built-in UART with transmit and receive circular buffers.
*
* 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 * An interrupt is generated when the UART has finished transmitting or
* receiving a byte. The interrupt handling routines use circular buffers * receiving a byte. The interrupt handling routines use circular buffers
@ -38,14 +38,13 @@ LICENSE:
* *
* The UART_RX_BUFFER_SIZE and UART_TX_BUFFER_SIZE constants define * The UART_RX_BUFFER_SIZE and UART_TX_BUFFER_SIZE constants define
* the size of the circular buffers in bytes. Note that these constants must be a power of 2. * the size of the circular buffers in bytes. Note that these constants must be a power of 2.
* You may need to adapt these constants to your target and your application by adding * You may need to adapt these constants to your target and your application by adding
* CDEFS += -DUART_RX_BUFFER_SIZE=nn -DUART_TX_BUFFER_SIZE=nn to your Makefile. * CDEFS += -DUART_RX_BUFFER_SIZE=nn -DUART_TX_BUFFER_SIZE=nn to your Makefile.
* *
* @note Based on Atmel Application Note AVR306 * @note Based on Atmel Application Note AVR306
* @author Peter Fleury pfleury@gmx.ch http://tinyurl.com/peterfleury * @author Peter Fleury pfleury@gmx.ch http://tinyurl.com/peterfleury
* @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3 * @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3
*/ */
#include <avr/pgmspace.h> #include <avr/pgmspace.h>
@ -53,39 +52,37 @@ LICENSE:
#error "This library requires AVR-GCC 4.5 or later, update to newer AVR-GCC compiler !" #error "This library requires AVR-GCC 4.5 or later, update to newer AVR-GCC compiler !"
#endif #endif
/**@{*/ /**@{*/
/* /*
** constants and macros ** constants and macros
*/ */
/** @brief UART Baudrate Expression /** @brief UART Baudrate Expression
* @param xtalCpu system clock in Mhz, e.g. 4000000UL for 4Mhz * @param xtalCpu system clock in Mhz, e.g. 4000000UL for 4Mhz
* @param baudRate baudrate in bps, e.g. 1200, 2400, 9600 * @param baudRate baudrate in bps, e.g. 1200, 2400, 9600
*/ */
#define UART_BAUD_SELECT(baudRate,xtalCpu) (((xtalCpu) + 8UL * (baudRate)) / (16UL * (baudRate)) -1UL) #define UART_BAUD_SELECT(baudRate, xtalCpu) (((xtalCpu) + 8UL * (baudRate)) / (16UL * (baudRate)) - 1UL)
/** @brief UART Baudrate Expression for ATmega double speed mode /** @brief UART Baudrate Expression for ATmega double speed mode
* @param xtalCpu system clock in Mhz, e.g. 4000000UL for 4Mhz * @param xtalCpu system clock in Mhz, e.g. 4000000UL for 4Mhz
* @param baudRate baudrate in bps, e.g. 1200, 2400, 9600 * @param baudRate baudrate in bps, e.g. 1200, 2400, 9600
*/ */
#define UART_BAUD_SELECT_DOUBLE_SPEED(baudRate,xtalCpu) ( ((((xtalCpu) + 4UL * (baudRate)) / (8UL * (baudRate)) -1UL)) | 0x8000) #define UART_BAUD_SELECT_DOUBLE_SPEED(baudRate, xtalCpu) \
(((((xtalCpu) + 4UL * (baudRate)) / (8UL * (baudRate)) - 1UL)) | 0x8000)
/** @brief Size of the circular receive buffer, must be power of 2 /** @brief Size of the circular receive buffer, must be power of 2
* *
* You may need to adapt this constant to your target and your application by adding * You may need to adapt this constant to your target and your application by adding
* CDEFS += -DUART_RX_BUFFER_SIZE=nn to your Makefile. * CDEFS += -DUART_RX_BUFFER_SIZE=nn to your Makefile.
*/ */
#ifndef UART_RX_BUFFER_SIZE #ifndef UART_RX_BUFFER_SIZE
#define UART_RX_BUFFER_SIZE 32 #define UART_RX_BUFFER_SIZE 32
#endif #endif
/** @brief Size of the circular transmit buffer, must be power of 2 /** @brief Size of the circular transmit buffer, must be power of 2
* *
* You may need to adapt this constant to your target and your application by adding * You may need to adapt this constant to your target and your application by adding
* CDEFS += -DUART_TX_BUFFER_SIZE=nn to your Makefile. * CDEFS += -DUART_TX_BUFFER_SIZE=nn to your Makefile.
*/ */
#ifndef UART_TX_BUFFER_SIZE #ifndef UART_TX_BUFFER_SIZE
@ -93,59 +90,56 @@ LICENSE:
#endif #endif
/* test if the size of the circular buffers fits into SRAM */ /* test if the size of the circular buffers fits into SRAM */
#if ( (UART_RX_BUFFER_SIZE+UART_TX_BUFFER_SIZE) >= (RAMEND-0x60 ) ) #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" #error "size of UART_RX_BUFFER_SIZE + UART_TX_BUFFER_SIZE larger than size of SRAM"
#endif #endif
/* /*
** high byte error return code of uart_getc() ** high byte error return code of uart_getc()
*/ */
#define UART_FRAME_ERROR 0x1000 /**< @brief Framing Error by UART */ #define UART_FRAME_ERROR 0x1000 /**< @brief Framing Error by UART */
#define UART_OVERRUN_ERROR 0x0800 /**< @brief Overrun condition by UART */ #define UART_OVERRUN_ERROR 0x0800 /**< @brief Overrun condition by UART */
#define UART_PARITY_ERROR 0x0400 /**< @brief Parity Error by UART */ #define UART_PARITY_ERROR 0x0400 /**< @brief Parity Error by UART */
#define UART_BUFFER_OVERFLOW 0x0200 /**< @brief receive ringbuffer overflow */ #define UART_BUFFER_OVERFLOW 0x0200 /**< @brief receive ringbuffer overflow */
#define UART_NO_DATA 0x0100 /**< @brief no receive data available */ #define UART_NO_DATA 0x0100 /**< @brief no receive data available */
/* /*
** function prototypes ** function prototypes
*/ */
/** /**
@brief Initialize UART and set baudrate @brief Initialize UART and set baudrate
@param baudrate Specify baudrate using macro UART_BAUD_SELECT() @param baudrate Specify baudrate using macro UART_BAUD_SELECT()
@return none @return none
*/ */
extern void uart_init(unsigned int baudrate); extern void uart_init(unsigned int baudrate);
/** /**
* @brief Get received byte from ringbuffer * @brief Get received byte from ringbuffer
* *
* Returns in the lower byte the received character and in the * Returns in the lower byte the received character and in the
* higher byte the last receive error. * higher byte the last receive error.
* UART_NO_DATA is returned when no data is available. * UART_NO_DATA is returned when no data is available.
* *
* @return lower byte: received byte from ringbuffer * @return lower byte: received byte from ringbuffer
* @return higher byte: last receive status * @return higher byte: last receive status
* - \b 0 successfully received data from UART * - \b 0 successfully received data from UART
* - \b UART_NO_DATA * - \b UART_NO_DATA
* <br>no receive data available * <br>no receive data available
* - \b UART_BUFFER_OVERFLOW * - \b UART_BUFFER_OVERFLOW
* <br>Receive ringbuffer overflow. * <br>Receive ringbuffer overflow.
* We are not reading the receive buffer fast enough, * We are not reading the receive buffer fast enough,
* one or more received character have been dropped * one or more received character have been dropped
* - \b UART_OVERRUN_ERROR * - \b UART_OVERRUN_ERROR
* <br>Overrun condition by UART. * <br>Overrun condition by UART.
* A character already present in the UART UDR register was * A character already present in the UART UDR register was
* not read by the interrupt handler before the next character arrived, * not read by the interrupt handler before the next character arrived,
* one or more received characters have been dropped. * one or more received characters have been dropped.
* - \b UART_FRAME_ERROR * - \b UART_FRAME_ERROR
* <br>Framing Error by UART * <br>Framing Error by UART
*/ */
extern unsigned int uart_getc(void); extern unsigned int uart_getc(void);
/** /**
* @brief Put byte to ringbuffer for transmitting via UART * @brief Put byte to ringbuffer for transmitting via UART
* @param data byte to be transmitted * @param data byte to be transmitted
@ -153,19 +147,17 @@ extern unsigned int uart_getc(void);
*/ */
extern void uart_putc(unsigned char data); extern void uart_putc(unsigned char data);
/** /**
* @brief Put string to ringbuffer for transmitting via UART * @brief Put string to ringbuffer for transmitting via UART
* *
* The string is buffered by the uart library in a circular buffer * 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. * 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. * Blocks if it can not write the whole string into the circular buffer.
* *
* @param s string to be transmitted * @param s string to be transmitted
* @return none * @return none
*/ */
extern void uart_puts(const char *s ); extern void uart_puts(const char *s);
/** /**
* @brief Put string from program memory to ringbuffer for transmitting via UART. * @brief Put string from program memory to ringbuffer for transmitting via UART.
@ -178,14 +170,12 @@ extern void uart_puts(const char *s );
* @return none * @return none
* @see uart_puts_P * @see uart_puts_P
*/ */
extern void uart_puts_p(const char *s ); extern void uart_puts_p(const char *s);
/** /**
* @brief Macro to automatically put a string constant into program memory * @brief Macro to automatically put a string constant into program memory
*/ */
#define uart_puts_P(__s) uart_puts_p(PSTR(__s)) #define uart_puts_P(__s) uart_puts_p(PSTR(__s))
/** @brief Initialize USART1 (only available on selected ATmegas) @see uart_init */ /** @brief Initialize USART1 (only available on selected ATmegas) @see uart_init */
extern void uart1_init(unsigned int baudrate); extern void uart1_init(unsigned int baudrate);
@ -194,14 +184,13 @@ extern unsigned int uart1_getc(void);
/** @brief Put byte to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_putc */ /** @brief Put byte to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_putc */
extern void uart1_putc(unsigned char data); extern void uart1_putc(unsigned char data);
/** @brief Put string to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_puts */ /** @brief Put string to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_puts */
extern void uart1_puts(const char *s ); extern void uart1_puts(const char *s);
/** @brief Put string from program memory to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_puts_p */ /** @brief Put string from program memory to ringbuffer for transmitting via USART1 (only available on selected ATmega)
extern void uart1_puts_p(const char *s ); * @see uart_puts_p */
extern void uart1_puts_p(const char *s);
/** @brief Macro to automatically put a string constant into program memory */ /** @brief Macro to automatically put a string constant into program memory */
#define uart1_puts_P(__s) uart1_puts_p(PSTR(__s)) #define uart1_puts_P(__s) uart1_puts_p(PSTR(__s))
/**@}*/ /**@}*/
#endif // UART_H
#endif // UART_H