ad_uart.h

Go to the documentation of this file.

 
#ifndef AD_UART_H_
#define AD_UART_H_
 
#if dg_configUART_ADAPTER
 
#include "ad.h"
#include "hw_uart.h"
#include "hw_dma.h"
#include "osal.h"
#include "resmgmt.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_UART_USE_ASYNC_TRANSACTIONS
#define CONFIG_UART_USE_ASYNC_TRANSACTIONS      (1)
#endif
 
#ifndef CONFIG_UART_USE_SYNC_TRANSACTIONS
#define CONFIG_UART_USE_SYNC_TRANSACTIONS       (1)
#endif
 
#if (CONFIG_UART_USE_SYNC_TRANSACTIONS == 0) && (CONFIG_UART_USE_ASYNC_TRANSACTIONS == 0)
#error "At least one macro CONFIG_UART_USE_SYNC_TRANSACTIONS or CONFIG_UART_USE_ASYNC_TRANSACTIONS must be set"
#endif
 
typedef void (*ad_uart_user_cb)(void *user_data, uint16_t transferred);
 
typedef enum
{
        AD_UART_RES_TYPE_CONFIG,
 
        AD_UART_RES_TYPE_WRITE,
 
        AD_UART_RES_TYPE_READ,
 
        AD_UART_RES_TYPES
} AD_UART_RES_TYPE;
 
 
typedef enum {
        AD_UART_ERROR_CONFIG_TX_SIZE            = -9,   
        AD_UART_ERROR_CONFIG_RX_SIZE            = -8,   
        AD_UART_ERROR_IO_CFG_INVALID            = -7,   
        AD_UART_ERROR_RESOURCE_NOT_AVAILABLE    = -6,   
        AD_UART_ERROR_CONTROLLER_BUSY           = -5,   
        AD_UART_ERROR_DEVICE_CLOSED             = -4,   
        AD_UART_ERROR_CONTROLLER_CONF_INVALID   = -3,   
        AD_UART_ERROR_AUTOFLOW_CONF_INVALID     = -2,   
        AD_UART_ERROR_HANDLE_INVALID            = -1,   
        AD_UART_ERROR_NONE                      = 0     
} AD_UART_ERROR;
 
 
typedef struct {
        ad_io_conf_t rx;                
        ad_io_conf_t tx;                
        ad_io_conf_t rtsn;              
        ad_io_conf_t ctsn;              
} ad_uart_io_conf_t;
 
typedef struct {
        uart_config  hw_conf;        
} ad_uart_driver_conf_t;
 
typedef struct {
        const HW_UART_ID id;                    
        const ad_uart_io_conf_t *io;            
        const ad_uart_driver_conf_t *drv;       
} ad_uart_controller_conf_t;
 
 
typedef void *ad_uart_handle_t;
 
 
void ad_uart_init(void);
 
 
ad_uart_handle_t ad_uart_open(const ad_uart_controller_conf_t *ad_uart_ctrl_conf);
 
 
int ad_uart_close(ad_uart_handle_t handle, bool force);
 
 
int ad_uart_reconfig(ad_uart_handle_t handle, const ad_uart_driver_conf_t *ad_drv);
 
#if (CONFIG_UART_USE_SYNC_TRANSACTIONS == 1)
 
int ad_uart_write(ad_uart_handle_t handle, const char *wbuf, size_t wlen);
 
 
int ad_uart_read(ad_uart_handle_t handle, char *rbuf, size_t rlen, OS_TICK_TIME timeout);
#endif /* CONFIG_UART_USE_SYNC_TRANSACTIONS */
 
#if (CONFIG_UART_USE_ASYNC_TRANSACTIONS == 1)
 
int ad_uart_write_async(ad_uart_handle_t handle, const char *wbuf, size_t wlen,
                          ad_uart_user_cb cb, void *user_data);
 
int ad_uart_read_async(ad_uart_handle_t handle, char *rbuf, size_t rlen, ad_uart_user_cb cb,
                         void *user_data);
 
int ad_uart_complete_async_read(ad_uart_handle_t handle);
 
int ad_uart_complete_async_write(ad_uart_handle_t handle);
#endif /* CONFIG_UART_USE_ASYNC_TRANSACTIONS */
 
HW_UART_ID ad_uart_get_hw_uart_id(ad_uart_handle_t handle);
 
int ad_uart_io_config (HW_UART_ID id, const ad_uart_io_conf_t *io, AD_IO_CONF_STATE state);
 
#ifdef __cplusplus
}
#endif
 
#endif /* dg_configUART_ADAPTER */
 
#endif /* AD_UART_H_ */