uart_extra.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef UART_EXTRA_H_
#define UART_EXTRA_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <drivers/uart/adi_uart.h>
#include <stdbool.h>
#include <stdint.h>
#include "no_os_error.h"
#include "no_os_irq.h"
 
#define NO_OS_UART_MAX_BYTES    1024u
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum UART_ERROR {
    NO_ERR              = 0x00,
    BAD_INPUT_PARAMETERS        = 0x01,
    WAITING_FOR_CALLBACK        = 0x02,
    HW_ERR_FRAMING                  = 0x10,
    HW_ERR_PARITY                   = 0x20,
    HW_ERR_OVERRUN                  = 0x40,
    BREAK_INTERRUPT                 = 0x80,
    HW_ERR_RX_CHAN_DMA_BUS_FAULT     = 0x100,
    HW_ERR_TX_CHAN_DMA_BUS_FAULT     = 0x200,
    HW_ERR_RX_CHAN_DMA_INVALID_DESCR = 0x400,
    HW_ERR_TX_CHAN_DMA_INVALID_DESCR = 0x800,
    HW_ERR_RX_CHAN_DMA_UNKNOWN_ERROR = 0x1000,
    HW_ERR_TX_CHAN_DMA_UNKNOWN_ERROR = 0x2000,
};
 
enum UART_WORDLEN {
    UART_WORDLEN_5BITS,
    UART_WORDLEN_6BITS,
    UART_WORDLEN_7BITS,
    UART_WORDLEN_8BITS
};
 
enum UART_PARITY {
    UART_NO_PARITY          =  0x0,
    UART_ODD_PARITY         =  0x8,
    UART_EVEN_PARITY        =  0x18,
    UART_ODD_PARITY_STICKY  =  0x28,
    UART_EVEN_PARITY_STICKY =  0x38
};
 
enum UART_STOPBITS {
    UART_ONE_STOPBIT               = 0x00,
    UART_ONE_AND_HALF_TWO_STOPBITS = 0x04
};
 
enum UART_BAUD {
    BD_9600 = 9600,
    BD_19200 = 19200,
    BD_38400 = 38400,
    BD_57600 = 57600,
    BD_115200 = 115200,
    BD_230400 = 230400,
    BD_460800 = 460800,
    BD_921600 = 921600,
    BD_1000000 = 1000000,
    BD_1500000 = 1500000
};
 
struct aducm_uart_init_param {
    enum UART_PARITY    parity;
    enum UART_STOPBITS  stop_bits;
    enum UART_WORDLEN   word_length;
};
 
struct no_os_baud_desc {
    uint32_t    baud_rate;
    uint16_t    div_n;
    uint8_t     div_m;
    uint16_t    div_c;
    uint8_t     osr;
};
 
struct no_os_op_desc {
    bool        is_nonblocking;
    uint8_t     *buff;
    uint32_t    pending;
};
 
struct no_os_aducm_uart_desc {
    ADI_UART_HANDLE uart_handler;
    enum UART_ERROR errors;
    bool        callback_enabled;
    uint8_t     *adi_uart_buffer;
    uint32_t    adi_uart_buffer_offset;
    struct no_os_op_desc    write_desc;
    struct no_os_op_desc    read_desc;
    struct no_os_irq_ctrl_desc *nvic;
    struct no_os_callback_desc rx_callback;
};
 
#endif /* UART_H_ */