twr_uart.h

#ifndef _TWR_UART_H
#define _TWR_UART_H
 
#include <twr_tick.h>
#include <twr_fifo.h>
 
 
 
typedef enum
{
    TWR_UART_UART0 = 0,
 
    TWR_UART_UART1 = 1,
 
    TWR_UART_UART2 = 2
 
} twr_uart_channel_t;
 
 
typedef enum
{
    TWR_UART_BAUDRATE_9600 = 0,
 
    TWR_UART_BAUDRATE_19200 = 1,
 
    TWR_UART_BAUDRATE_38400 = 2,
 
    TWR_UART_BAUDRATE_57600 = 3,
 
    TWR_UART_BAUDRATE_115200 = 4,
 
    TWR_UART_BAUDRATE_921600 = 5
 
} twr_uart_baudrate_t;
 
 
 
#define _TWR_UART_SETTING_DATA_BITS_7   0x07 << 4
#define _TWR_UART_SETTING_DATA_BITS_8   0x08 << 4
 
#define _TWR_UART_SETTING_PARITY_NONE   0x00 << 2
#define _TWR_UART_SETTING_PARITY_EVEN   0x02 << 2
#define _TWR_UART_SETTING_PARITY_ODD    0x03 << 2
 
#define _TWR_UART_SETTING_STOP_BIT_1   0x00
#define _TWR_UART_SETTING_STOP_BIT_2   0x02
#define _TWR_UART_SETTING_STOP_BIT_15  0x03
 
 
typedef enum
{
    TWR_UART_SETTING_8N1 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_8E1 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_8O1 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_ODD | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_8N2 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_8E2 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_8O2 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_8N1_5 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_15,
 
    TWR_UART_SETTING_8E1_5 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_15,
 
    TWR_UART_SETTING_8O1_5 = _TWR_UART_SETTING_DATA_BITS_8 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_15,
 
    TWR_UART_SETTING_7N1 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_7E1 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_7O1 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_ODD | _TWR_UART_SETTING_STOP_BIT_1,
 
    TWR_UART_SETTING_7N2 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_7E2 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_7O2 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_2,
 
    TWR_UART_SETTING_7N1_5 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_15,
 
    TWR_UART_SETTING_7E1_5 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_EVEN | _TWR_UART_SETTING_STOP_BIT_15,
 
    TWR_UART_SETTING_7O1_5 = _TWR_UART_SETTING_DATA_BITS_7 | _TWR_UART_SETTING_PARITY_NONE | _TWR_UART_SETTING_STOP_BIT_15
 
} twr_uart_setting_t;
 
 
typedef enum
{
    TWR_UART_EVENT_ASYNC_WRITE_DONE = 0,
 
    TWR_UART_EVENT_ASYNC_READ_DATA = 1,
 
    TWR_UART_EVENT_ASYNC_READ_TIMEOUT = 2
 
} twr_uart_event_t;
 
 
void twr_uart_init(twr_uart_channel_t channel, twr_uart_baudrate_t baudrate, twr_uart_setting_t setting);
 
 
void twr_uart_deinit(twr_uart_channel_t channel);
 
 
size_t twr_uart_write(twr_uart_channel_t channel, const void *buffer, size_t length);
 
 
size_t twr_uart_read(twr_uart_channel_t channel, void *buffer, size_t length, twr_tick_t timeout);
 
 
void twr_uart_set_event_handler(twr_uart_channel_t channel, void (*event_handler)(twr_uart_channel_t, twr_uart_event_t, void *), void *event_param);
 
 
void twr_uart_set_async_fifo(twr_uart_channel_t channel, twr_fifo_t *write_fifo, twr_fifo_t *read_fifo);
 
 
size_t twr_uart_async_write(twr_uart_channel_t channel, const void *buffer, size_t length);
 
 
bool twr_uart_async_read_start(twr_uart_channel_t channel, twr_tick_t timeout);
 
 
bool twr_uart_async_read_cancel(twr_uart_channel_t channel);
 
 
size_t twr_uart_async_read(twr_uart_channel_t channel, void *buffer, size_t length);
 
 
#endif // _TWR_UART_H