xf_hal_uart.h

浏览该文件的文档.

 
#ifndef __XF_HAL_UART_H__
#define __XF_HAL_UART_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_UART_IS_ENABLE
 
#include "xf_hal_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_uart_num_t;
 
typedef enum _xf_hal_uart_data_bits_t {
    _XF_HAL_UART_DATA_BIT_BASE = 0,
 
    XF_HAL_UART_DATA_BIT_5 = _XF_HAL_UART_DATA_BIT_BASE,  
    XF_HAL_UART_DATA_BIT_6, 
    XF_HAL_UART_DATA_BIT_7, 
    XF_HAL_UART_DATA_BIT_8, 
    XF_HAL_UART_DATA_BIT_9, 
    _XF_HAL_UART_DATA_BIT_MAX,
} xf_hal_uart_data_bits_t;
 
typedef enum _xf_hal_uart_stop_bits_t {
    _XF_HAL_UART_STOP_BIT_BASE = 0,
 
    XF_HAL_UART_STOP_BIT_1 = _XF_HAL_UART_STOP_BIT_BASE, 
    XF_HAL_UART_STOP_BIT_1_5,   
    XF_HAL_UART_STOP_BIT_2,     
    _XF_HAL_UART_STOP_BIT_MAX,
} xf_hal_uart_stop_bits_t;
 
typedef enum _xf_hal_uart_parity_bits_t {
    _XF_HAL_UART_PARITY_BITS_BASE = 0,
 
    XF_HAL_UART_PARITY_BITS_NONE = _XF_HAL_UART_PARITY_BITS_BASE, 
    XF_HAL_UART_PARITY_BITS_EVEN,   
    XF_HAL_UART_PARITY_BITS_ODD,    
    XF_HAL_UART_PARITY_BITS_SPACE,  
    XF_HAL_UART_PARITY_BITS_MARK,   
    _XF_HAL_UART_PARITY_BITS_MAX,
} xf_hal_uart_parity_bits_t;
 
typedef enum _xf_hal_uart_flow_control_t {
    _XF_HAL_UART_FLOW_CONTROL_BASE = 0,
 
    XF_HAL_UART_FLOW_CONTROL_NONE = _XF_HAL_UART_FLOW_CONTROL_BASE, 
    XF_HAL_UART_FLOW_CONTROL_RTS,       
    XF_HAL_UART_FLOW_CONTROL_CTS,       
    XF_HAL_UART_FLOW_CONTROL_RTS_CTS,   
    _XF_HAL_UART_FLOW_CONTROL_MAX,
} xf_hal_uart_flow_control_t;
 
typedef enum _xf_hal_uart_cmd_t {
    XF_HAL_UART_CMD_DEFAULT         = 0x0,          
    XF_HAL_UART_CMD_ENABLE          = 0x1 << 0,     
    XF_HAL_UART_CMD_DATA_BITS       = 0x1 << 1,     
    XF_HAL_UART_CMD_STOP_BITS       = 0x1 << 2,     
    XF_HAL_UART_CMD_PARITY_BITS     = 0x1 << 3,     
    XF_HAL_UART_CMD_FLOW_CONTROL    = 0x1 << 4,     
    XF_HAL_UART_CMD_BAUDRATE        = 0x1 << 5,     
    XF_HAL_UART_CMD_TX_NUM          = 0x1 << 6,     
    XF_HAL_UART_CMD_RX_NUM          = 0x1 << 7,     
    XF_HAL_UART_CMD_RTS_NUM         = 0x1 << 8,     
    XF_HAL_UART_CMD_CTS_NUM         = 0x1 << 9,     
    XF_HAL_UART_CMD_ALL             = 0x7FFFFFFF, 
} xf_hal_uart_cmd_t;
 
typedef struct _xf_hal_uart_config_t {
    uint32_t enable         : 1;    
    uint32_t data_bits      : 3;    
    uint32_t stop_bits      : 2;    
    uint32_t parity_bits    : 3;    
    uint32_t flow_control   : 3;    
    uint32_t reserve        : 20;
    uint32_t baudrate;              
    xf_gpio_num_t tx_num;           
    xf_gpio_num_t rx_num;           
    xf_gpio_num_t rts_num;          
    xf_gpio_num_t cts_num;          
} xf_hal_uart_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_uart_init(xf_uart_num_t uart_num, uint32_t baudrate);
 
xf_err_t xf_hal_uart_deinit(xf_uart_num_t uart_num);
 
xf_err_t xf_hal_uart_enable(xf_uart_num_t uart_num);
 
xf_err_t xf_hal_uart_disable(xf_uart_num_t uart_num);
 
xf_err_t xf_hal_uart_set_gpio(xf_uart_num_t uart_num, xf_gpio_num_t tx_num, xf_gpio_num_t rx_num);
 
xf_err_t xf_hal_uart_set_config(xf_uart_num_t uart_num, xf_hal_uart_data_bits_t data_bits,
                                xf_hal_uart_stop_bits_t stop_bits, xf_hal_uart_parity_bits_t parity_bits);
 
xf_err_t xf_hal_uart_set_baudrate(xf_uart_num_t uart_num, uint32_t baudrate);
 
uint32_t xf_hal_uart_get_baudrate(xf_uart_num_t uart_num);
 
xf_err_t xf_hal_uart_set_flow_control(xf_uart_num_t uart_num, xf_hal_uart_flow_control_t flow_control,
                                      xf_gpio_num_t rts_num, xf_gpio_num_t cts_num);
 
int xf_hal_uart_read(xf_uart_num_t uart_num, uint8_t *data, uint32_t data_len);
 
int xf_hal_uart_write(xf_uart_num_t uart_num, const uint8_t *data, uint32_t data_len);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // XF_HAL_UART_IS_ENABLE
 
#endif // __XF_HAL_UART_H__