uart.h

 
/***************************************************************************/
 
#ifndef _UART_H_
#define _UART_H_
 
/*******************************************************************************
*                               Include files
*******************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
#include "clk.h"
#include "syna_device.h"
#include "uart_registers.h"
 
/*******************************************************************************
*                               Enumerated Types
*******************************************************************************/


typedef enum
{
    UART_OK,                           
    UART_ERROR,                        
    UART_ERROR_BUSY,                   
    UART_ERROR_TIMEOUT,                
    UART_ERROR_UNSUPPORTED,            
    UART_ERROR_PARAMETER,              
    UART_ERROR_TX_UNDERFLOW,           
    UART_ERROR_RX_OVERFLOW,            
    UART_ERROR_RX_BREAK_DETECTED,      
    UART_ERROR_BAUDRATE,               
    UART_ERROR_NOT_INITIALIZED,        
    UART_ERROR_RX_BUSY,                
    UART_ERROR_TX_BUSY,                
    UART_ERROR_TX_TIMEOUT,             
    UART_ERROR_RX_TIMEOUT,             
    UART_ERROR_FRAMING,                
    UART_ERROR_PARITY,                 
    UART_ERROR_DATA_BITS,              
    UART_ERROR_STOP_BITS,              
    UART_ERROR_INSTANCE,               
    UART_ERROR_FLOW_CONTROL,           
    UART_ERROR_INTERRUPT_MODE          
} uart_status_en;

typedef enum
{
    UART_SUCCESS,                
    UART_RX_TIMEOUT,             
    UART_BUSY,                   
    UART_TX_DATA_NOT_READY,      
    UART_RX_DATA_NOT_READY,      
    UART_RX_BREAK,               
    UART_RX_FRAMING_ERROR,       
    UART_RX_PARITY_ERROR,        
    UART_RX_OVERRUN_ERROR,       
    UART_ABORT_TRANSFER,         
    UART_UNKNOWN_ERROR           
} uart_cb_param_en;

typedef enum
{
    UART_CHAR_LEN_FIVE   = 0x05,   
    UART_CHAR_LEN_SIX    = 0x06,   
    UART_CHAR_LEN_SEVEN  = 0x07,   
    UART_CHAR_LEN_EIGHT  = 0x08,   
} uart_char_len_en;

typedef enum
{
    UART_STOP_BITS_ONE,        
    UART_STOP_BITS_ONE_FIVE,   
    UART_STOP_BITS_TWO         
} uart_stop_bits_en;

typedef enum
{
    UART_PARITY_NONE,          
    UART_PARITY_EVEN,          
    UART_PARITY_ODD            
} uart_parity_en;

typedef enum
{
    UART_RX_INT        = (1U << 0),  
    UART_TX_INT        = (1U << 1),  
    UART_ERROR_INT     = (1U << 2),  
    UART_MODEM_INT     = (1U << 3)   
} uart_int_mask_en;

typedef enum
{
    UART_TX_FIFO_EMPTY   = 0x00,   
    UART_TX_FIFO_TWO     = 0x01,   
    UART_TX_FIFO_QUARTER = 0x02,   
    UART_TX_FIFO_HALF    = 0x03    
} uart_tx_fifo_trigger_en;

typedef enum
{
    UART_RX_FIFO_ONE     = 0x00,   
    UART_RX_FIFO_QUARTER = 0x01,   
    UART_RX_FIFO_HALF    = 0x02,   
    UART_RX_FIFO_TWO     = 0x03    
} uart_rx_fifo_trigger_en;

typedef enum
{
    IIR_IID_UART_MODEM_STATUS        = 0x0, 
    IIR_IID_NO_INTERRUPT_PENDING     = 0x1, 
    IIR_IID_THR_EMPTY                = 0x2, 
    IIR_IID_RECEIVED_DATA_AVAILABLE  = 0x4, 
    IIR_IID_RECEIVER_LINE_STATUS     = 0x6, 
    IIR_IID_BUSY_DETECT              = 0x7, 
    IIR_IID_CHARACTER_TIMEOUT        = 0xC  
} uart_int_id_en;

typedef enum
{
    TX_IN_PROGRESS, 
    TX_COMPLETE,    
    TX_ERROR        
} uart_put_status_en;

typedef enum
{
    RX_IN_PROGRESS, 
    RX_COMPLETE,    
    RX_ERROR        
} uart_get_status_en;

 
/*******************************************************************************
*                            Type Definitions
*******************************************************************************/


typedef void (*uart_cb_t)(uint32_t event_mask, void *user_data);

typedef struct {
    /* USR bits [0:7] */
    uint16_t busy_not_used      : 1; 
    uint16_t tx_fifo_not_full   : 1; 
    uint16_t tx_fifo_empty      : 1; 
    uint16_t rx_fifo_not_empty  : 1; 
    uint16_t rx_fifo_full       : 1; 
    uint16_t reserved_5         : 1; 
    uint16_t reserved_6         : 1; 
    uint16_t reserved_7         : 1; 
 
    /* LSR bits [8:15] */
    uint16_t data_ready         : 1; 
    uint16_t overrun_error      : 1; 
    uint16_t parity_error       : 1; 
    uint16_t framing_error      : 1; 
    uint16_t break_detected     : 1; 
    uint16_t thr_empty          : 1; 
    uint16_t tx_empty           : 1; 
    uint16_t rx_fifo_error      : 1; 
} uart_usr_lsr_status_bits_t;

typedef struct
{
    uart_usr_lsr_status_bits_t uart_status; 
    bool tx_busy;                           
    bool rx_busy;                           
} uart_hw_status_t;

typedef struct
{
    uart_parity_en parity;            
    uart_char_len_en char_len;        
    uart_stop_bits_en stop_bits;      
    bool flow_control;                
    uint32_t baud_rate;                
} uart_config_t;

typedef struct
{
    char *put_buff;               
    uint32_t num;                 
    uart_cb_t callback;           
    void *user_data;              
    bool wait_for_tx_fifo_drain;  
 
} uart_put_config_t;

typedef struct
{
    char *get_buff;         
    uint32_t num;           
    uart_cb_t callback;     
    void *user_data;        
} uart_get_config_t;
 
 
/*******************************************************************************
*                          Function Prototypes
*******************************************************************************/

 
/*******************************************************************************
* Function Name: uart_init
****************************************************************************/
 
INIT_CODE uart_status_en uart_init(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_deinit
****************************************************************************/
 
INIT_CODE uart_status_en uart_deinit(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_set_configuration
****************************************************************************/
 
uart_status_en uart_set_configuration(uart_instance_en id, uart_config_t *cfg, 
                                                                    uint32_t* achieved_baudrate);
 
/*******************************************************************************
* Function Name: uart_get_configuration
****************************************************************************/
 
uart_status_en uart_get_configuration(uart_instance_en id, uart_config_t *cfg, 
                                                                    uint32_t* achieved_baudrate);

 
/*******************************************************************************
*                          High level functions definitions
*******************************************************************************/

 
 /*******************************************************************************
* Function Name: uart_put_non_blocking
****************************************************************************/
 
uart_status_en uart_put_non_blocking(uart_instance_en id, uart_put_config_t *put_config);
 
/*******************************************************************************
* Function Name: uart_get_non_blocking
****************************************************************************/
 
uart_status_en uart_get_non_blocking(uart_instance_en id, uart_get_config_t *xfer, 
                                                                uint32_t* received_chars);
 
/*******************************************************************************
* Function Name: uart_abort_put
****************************************************************************/
 
uart_status_en uart_abort_put(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_abort_get
****************************************************************************/
 
uart_status_en uart_abort_get(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_num_transmitted
****************************************************************************/
 
uint32_t uart_get_num_transmitted(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_num_received
****************************************************************************/
 
uint32_t uart_get_num_received(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_put_status
****************************************************************************/
 
uart_put_status_en uart_get_put_status(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_get_status
****************************************************************************/
 
uart_get_status_en uart_get_get_status(uart_instance_en id);
 

 
 
/*******************************************************************************
*                          Low level functions declarations
*******************************************************************************/

 
 /*******************************************************************************
* Function Name: uart_put_blocking
****************************************************************************/
 
uart_status_en uart_put_blocking(uart_instance_en id, char *put_buff, uint32_t num, 
                                                uint32_t timeout, bool wait_for_tx_fifo_drain);
 
/*******************************************************************************
* Function Name: uart_put_char_blocking
****************************************************************************/
 
uart_status_en uart_put_char_blocking(uart_instance_en id, char chr, uint32_t timeout);
 
/*******************************************************************************
* Function Name: uart_get_blocking
****************************************************************************/
 
uart_status_en uart_get_blocking(uart_instance_en id, char *get_buff, uint32_t num, 
                                                                        uint32_t timeout);
 
/*******************************************************************************
* Function Name: uart_get_char_blocking
****************************************************************************/
 
uart_status_en uart_get_char_blocking(uart_instance_en id, char *p_chr, uint32_t timeout);
 
/*******************************************************************************
* Function Name: uart_enable_ints
****************************************************************************/
 
void uart_enable_ints(uart_instance_en id, uint32_t mask);
 
/*******************************************************************************
* Function Name: uart_get_enabled_ints
****************************************************************************/
 
uint32_t uart_get_enabled_ints(uart_instance_en id);
 
/* \cond */
/*******************************************************************************
* Function Name: uart_isr
****************************************************************************/
 
ISR_CODE void uart_isr(uart_instance_en id);
/* \endcond */
 
/*******************************************************************************
* Function Name: uart_get_status
****************************************************************************/
 
uart_hw_status_t uart_get_status(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_set_tx_fifo_trigger
****************************************************************************/
void uart_set_tx_fifo_trigger(uart_instance_en id, uart_tx_fifo_trigger_en thres);
 
/*******************************************************************************
* Function Name: uart_set_rx_fifo_trigger
****************************************************************************/
void uart_set_rx_fifo_trigger(uart_instance_en id, uart_rx_fifo_trigger_en thres);
 
/*******************************************************************************
* Function Name: uart_get_tx_fifo_trigger
****************************************************************************/
uart_tx_fifo_trigger_en uart_get_tx_fifo_trigger(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_rx_fifo_trigger
****************************************************************************/
uart_rx_fifo_trigger_en uart_get_rx_fifo_trigger(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_num_in_tx_fifo
****************************************************************************/
uint32_t uart_get_num_in_tx_fifo(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_get_num_in_rx_fifo
****************************************************************************/
uint32_t uart_get_num_in_rx_fifo(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_put_break
****************************************************************************/
void uart_put_break(uart_instance_en id, bool send_break);
 
/*******************************************************************************
* Function Name: uart_get_interrupt_id
****************************************************************************/
uart_int_id_en uart_get_interrupt_id(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_room_to_transmit
****************************************************************************/
 
bool uart_room_to_transmit(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_recv_char_avail
****************************************************************************/
bool uart_recv_char_avail(uart_instance_en id);
 
/*******************************************************************************
* Function Name: uart_put_char
****************************************************************************/
void uart_put_char(uart_instance_en id, char chr);
 
/*******************************************************************************
* Function Name: uart_get_char
****************************************************************************/
char uart_get_char(uart_instance_en id);


 
#endif /* _UART_H_ */