hal_uart.h

浏览该文件的文档.

 
#ifndef HAL_UART_H
#define HAL_UART_H
 
#include <stdint.h>
#include <stdbool.h>
#include "common_def.h"
#include "errcode.h"
#include "uart_porting.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
typedef struct {
    pin_t tx_pin;                   
    pin_t rx_pin;                   
    pin_t cts_pin;                  
    pin_t rts_pin;                  
} hal_uart_pin_config_t;
 
typedef enum hal_uart_data_bit {
    UART_DATA_BIT_5,                
    UART_DATA_BIT_6,                
    UART_DATA_BIT_7,                
    UART_DATA_BIT_8                 
} hal_uart_data_bit_t;
 
typedef enum hal_uart_parity {
    UART_PARITY_NONE,               
    UART_PARITY_ODD,                
    UART_PARITY_EVEN                
} hal_uart_parity_t;
 
typedef enum hal_uart_stop_bit {
    UART_STOP_BIT_1,                
    UART_STOP_BIT_2                 
} hal_uart_stop_bit_t;
 
typedef enum {
    UART_FIFO_INT_RX_LEVEL_1_CHARACTER = 0, // only for uart v100 and v151
    UART_FIFO_INT_RX_LEVEL_1_8 = 0, // only for uart v120
    UART_FIFO_INT_RX_LEVEL_1_4 = 1,
    UART_FIFO_INT_RX_LEVEL_1_2 = 2,
    UART_FIFO_INT_RX_LEVEL_2_LESS_THAN_FULL = 3, // only for uart v100 and v151
    UART_FIFO_INT_RX_LEVEL_3_4 = 3,
    UART_FIFO_INT_RX_LEVEL_7_8 = 4, // only for uart v120
} uart_fifo_rx_int_lvl_t;
 
typedef enum {
    UART_FIFO_INT_TX_LEVEL_EQ_0_CHARACTER = 0, // only for uart v100 and v151
    UART_FIFO_INT_TX_LEVEL_1_8 = 0, // only for uart v120
    UART_FIFO_INT_TX_LEVEL_EQ_2_CHARACTER = 1, // only for uart v100 and v151
    UART_FIFO_INT_TX_LEVEL_1_4 = 2,
    UART_FIFO_INT_TX_LEVEL_1_2 = 3,
    UART_FIFO_INT_TX_LEVEL_3_4 = 4, // only for uart v120
    UART_FIFO_INT_TX_LEVEL_7_8 = 5, // only for uart v120
} uart_fifo_tx_int_lvl_t;
 
typedef enum hal_uart_ctrl_id {
    UART_CTRL_SET_ATTR = 0,        
    UART_CTRL_GET_ATTR,            
#if defined(CONFIG_UART_SUPPORT_TX_INT)
    UART_CTRL_EN_TX_INT,           
#endif
    UART_CTRL_EN_RX_INT,           
    UART_CTRL_EN_IDLE_INT,         
    UART_CTRL_EN_PARITY_ERR_INT,   
    UART_CTRL_EN_FRAME_ERR_INT,    
    UART_CTRL_CHECK_TX_FIFO_FULL,  
    UART_CTRL_CHECK_TX_BUSY,       
    UART_CTRL_CHECK_RX_FIFO_EMPTY, 
    UART_CTRL_FIFO_ENABLE,         
    UART_CTRL_SET_RX_FIFO_LEVEL,   
    UART_CTRL_SET_TX_FIFO_LEVEL,   
    UART_CTRL_GET_REG_ADDRS,       
    UART_CTRL_TX_DMA_PROCESS,      
    UART_CTRL_FLOW_CTRL,           
    UART_CTRL_RESTORE,             
    UART_CTRL_CHECK_UART_BUSY,     
    UART_CTRL_GET_RX_FIFO_PASSNUM, 
#if defined(CONFIG_UART_SUPPORT_LPM)
    UART_CTRL_SUSPEND, 
    UART_CTRL_RESUME,  
#endif                 /* CONFIG_UART_SUPPORT_LPM */
#if defined(CONFIG_UART_SUPPORT_DMA)
    UART_CTRL_GET_DMA_DATA_ADDR,
#endif
    UART_CTRL_GET_RX_FIFO_THRESHOLD, 
    UART_CTRL_MAX,
    UART_CTRL_ID_INVALID = 0xFF
} hal_uart_ctrl_id_t;
 
typedef enum hal_uart_evt_id {
    UART_EVT_RX_ISR = 1,            
    UART_EVT_TX_ISR,                
    UART_EVT_IDLE_ISR,              
    UART_EVT_PARITY_ERR_ISR,        
    UART_EVT_FRAME_ERR_ISR,         
    UART_EVT_BREAK_ERR_ISR,         
    UART_EVT_OVERRUN_ERR_ISR,       
} hal_uart_evt_id_t;
 
typedef enum {
    UART_DMA_PROCESS_PREPARE,       
    UART_DMA_PROCESS_FINISH,        
    UART_DMA_PROCESS_INVALID = 0xFF
} hal_uart_dma_process_t;
 
typedef enum {
    UART_FLOW_CTRL_NONE = 0x0,
    UART_FLOW_CTS = 0x1,
    UART_FLOW_RTS = 0x2,
    UART_FLOW_CTRL_RTS_CTS = UART_FLOW_CTS | UART_FLOW_RTS,
    UART_FLOW_CTRL_SOFT = 0x4
} hal_uart_flow_ctrl_t;
 
typedef struct uart_attr {
    uint32_t baud_rate;                 
    uint8_t data_bits;                  
    uint8_t stop_bits;                  
    uint8_t parity;                     
    uint8_t flow_ctrl;                  
} hal_uart_attr_t;
 
typedef struct uart_extra_attr {
    bool tx_dma_enable;                     
    uint8_t tx_int_threshold;               
    bool rx_dma_enable;                     
    uint8_t rx_int_threshold;               
#if defined(CONFIG_UART_SUPPORT_RX_THREAD)
    bool rx_thread_enable;               
#endif
} hal_uart_extra_attr_t;
 
typedef errcode_t (*hal_uart_callback_t)(uart_bus_t bus, hal_uart_evt_id_t evt, uintptr_t param);
 
typedef errcode_t (*hal_uart_init_t)(uart_bus_t bus, hal_uart_callback_t callback, const hal_uart_pin_config_t *pins,
                                     const hal_uart_attr_t *attr, hal_uart_flow_ctrl_t flow_ctrl,
                                     hal_uart_extra_attr_t *extra_attr);
typedef errcode_t (*hal_uart_deinit_t)(uart_bus_t bus);
 
typedef errcode_t (*hal_uart_ctrl_t)(uart_bus_t bus, hal_uart_ctrl_id_t id, uintptr_t param);
 
typedef errcode_t (*hal_uart_write_t)(uart_bus_t bus, const uint8_t *data, uint16_t len);
 
typedef int32_t (*hal_uart_read_t)(uart_bus_t bus, const uint8_t *data, uint16_t len);
 
typedef void (*hal_uart_dma_cfg_t)(uart_bus_t bus, const hal_uart_extra_attr_t *extra_attr);
 
typedef struct {
    hal_uart_init_t   init;               
    hal_uart_deinit_t deinit;             
    hal_uart_ctrl_t   ctrl;               
    hal_uart_write_t  write;              
    hal_uart_read_t   read;               
    hal_uart_dma_cfg_t   dma_cfg;         
} hal_uart_funcs_t;
 
errcode_t hal_uart_register_funcs(uart_bus_t bus, hal_uart_funcs_t *funcs);
 
errcode_t hal_uart_unregister_funcs(uart_bus_t bus);
 
uintptr_t hal_uart_base_addrs_get(uart_bus_t bus);
 
errcode_t hal_uart_regs_init(uart_bus_t bus);
 
hal_uart_funcs_t *hal_uart_get_funcs(uart_bus_t bus);
 
errcode_t hal_uart_set_tx_fifo_int_level(uart_bus_t bus, uart_fifo_tx_int_lvl_t level);
 
errcode_t hal_uart_set_rx_fifo_int_level(uart_bus_t bus, uart_fifo_rx_int_lvl_t level);
 
errcode_t hal_uart_init(uart_bus_t bus, hal_uart_callback_t callback, const hal_uart_pin_config_t *pins,
                        const hal_uart_attr_t *attr, hal_uart_flow_ctrl_t flow_ctrl, hal_uart_extra_attr_t *extra_attr);
errcode_t hal_uart_deinit(uart_bus_t bus);
 
errcode_t hal_uart_ctrl(uart_bus_t bus, hal_uart_ctrl_id_t id, uintptr_t param);
 
errcode_t hal_uart_write(uart_bus_t bus, const uint8_t *data, uint16_t len);
 
int32_t hal_uart_read(uart_bus_t bus, const uint8_t *data, uint16_t len);
 
void hal_uart_set_dma_config(uart_bus_t bus, const hal_uart_extra_attr_t *extra_attr);
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif