uart.h

Go to the documentation of this file.

#ifndef _UART_H_
#define _UART_H_

#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>

// Get project/library configuration
#include "project_settings.h"

#ifdef USE_MODULE_SUBSYSTEM
#include "subsystem.h"
#endif

#ifdef USE_MODULE_TASK
#include "task.h"
#endif

#ifdef USE_MODULE_BUFFER_PRINTF
#include "buffer_printf.h"
#endif

#include "buffer.h"

enum uart_errors {
    BREAK_ERROR = 0,
    PARITY_ERROR,
    FRAMING_ERROR,
    OVERRUN_ERROR,
    NUM_UART_ERRORS
};

/**************************************
 * Hardware Abstraction Layer Includes
 *************************************/
#include "hal_uart.h"

void UART_Init(uint8_t channel);

void UART_ReconfigureBaud(uint8_t channel, uint32_t baud);

void UART_WriteByte(uint8_t channel, uint8_t c);

int8_t UART_Write(uint8_t channel, uint8_t * data, uint16_t length);

// this module could be used without buffer_printf if these functions are
// not used. Flag added to make it easy to not require buffer_printf
#ifdef _BUFFER_PRINTF_H_

void UART_printf(uint8_t channel, char * str, ...);

void UART_vprintf(uint8_t channel, char * str, va_list vars);
#endif

uint8_t UART_IsTransmitting(uint8_t channel);

void UART_Tick(void);

int8_t UART_RegisterReceiver(uint8_t channel, void(*fn)(uint8_t));

void UART_UnregisterReceiver(uint8_t channel, void(*fn)(uint8_t));

void UART_RegisterErrorCallback(uint8_t channel, void(*callback)(enum uart_errors));

void UART_RegisterTxOverwriteCallback(uint8_t channel, void(*overwriteCallback)(void));

void UART_RegisterRxOverwriteCallback(uint8_t channel, void(*overwriteCallback)(void));


/**************************************
 * Hardware Abstraction Layer Declarations
 *************************************/

 // In some cases the HAL will implement these with a #define which is why each is
 // surrounded with a #ifndef / #endif
 
 #ifndef hal_UART_Init
void hal_UART_Init(uint8_t channel, uint32_t baud);
#endif


#ifndef hal_UART_ReconfigureBaud
void hal_UART_ReconfigureBaud(uint8_t channel, uint32_t baud);
#endif

#ifndef UART_Tx_Handler
void UART_Tx_Handler(uint8_t channel);
#endif

#ifndef UART_Rx_Handler
void UART_Rx_Handler(uint8_t channel);
#endif

#ifndef UART_Error_Handler
void UART_Error_Handler(uint8_t channel, enum uart_errors error);
#endif

#ifndef hal_UART_Enable
void hal_UART_Enable(uint8_t channel);
#endif

#ifndef hal_UART_Disable
void hal_UART_Disable(uint8_t channel);
#endif

#ifndef hal_UART_SpaceAvailable
uint8_t hal_UART_SpaceAvailable(uint8_t channel);
#endif

#ifndef hal_UART_DataAvailable
uint8_t hal_UART_DataAvailable(uint8_t channel);
#endif

#ifndef hal_UART_ClearRxIF
void hal_UART_ClearRxIF(uint8_t channel);
#endif

#ifndef hal_UART_ClearTxIF
void hal_UART_ClearTxIF(uint8_t channel);
#endif

#ifndef hal_UART_EnableRxInterrupt
void hal_UART_EnableRxInterrupt(uint8_t channel);
#endif

#ifndef hal_UART_EnableTxInterrupt
void hal_UART_EnableTxInterrupt(uint8_t channel);
#endif

#ifndef hal_UART_DisableRxInterrupt
void hal_UART_DisableRxInterrupt(uint8_t channel);
#endif

#ifndef hal_UART_DisableTxInterrupt
void hal_UART_DisableTxInterrupt(uint8_t channel);
#endif

#ifndef hal_UART_RxInterruptEnabled
uint8_t hal_UART_RxInterruptEnabled(uint8_t channel);
#endif

#ifndef hal_UART_TxInterruptEnabled
uint8_t hal_UART_TxInterruptEnabled(uint8_t channel);
#endif

#ifndef hal_UART_RxByte
uint8_t hal_UART_RxByte(uint8_t channel);
#endif

#ifndef hal_UART_TxByte
void hal_UART_TxByte(uint8_t channel, uint8_t data);
#endif

#endif /* _UART_H_ */