xt_hal_uart.h

浏览该文件的文档.

 
#ifndef __XT_HAL_UART_H__
#define __XT_HAL_UART_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_HAL_UART_INVALID_ID            (0xFF)
 
#define XT_HAL_UART_STOP_BITS_S           (0) // [0..2]
#define XT_HAL_UART_STOP_BITS_W           (3)
#define XT_HAL_UART_PARITY_S              (3) // [3..4]
#define XT_HAL_UART_PARITY_W              (2)
#define XT_HAL_UART_WORD_LEN_S            (5) // [5..7]
#define XT_HAL_UART_WORD_LEN_W            (3)
 
#define XT_HAL_UART_WORD_LEN_5            (0)   
#define XT_HAL_UART_WORD_LEN_6            (1)   
#define XT_HAL_UART_WORD_LEN_7            (2)   
#define XT_HAL_UART_WORD_LEN_8            (3)   
#define XT_HAL_UART_WORD_LEN_9            (4)   
 
#define XT_HAL_UART_STOP_BITS_1           (0)   
#define XT_HAL_UART_STOP_BITS_2           (1)   
#define XT_HAL_UART_STOP_BITS_0_5         (2)   
#define XT_HAL_UART_STOP_BITS_1_5        `(3)   
 
#define XT_HAL_UART_PARITY_N              (0)   
#define XT_HAL_UART_PARITY_E              (1)   
#define XT_HAL_UART_PARITY_O              (2)   

#define XT_HAL_UART_PRESET(_word_length, _parity, _stop_bits) \
    (((XT_HAL_UART_WORD_LEN##_word_length)    << XT_HAL_UART_WORD_LEN_S) | \
     ((XT_HAL_UART_PARITY##_parity)           << XT_HAL_UART_PARITY_S) | \
     ((XT_HAL_UART_STOP_BITS##_stop_bits)     << XT_HAL_UART_STOP_BITS_S))
 
#define XT_HAL_UART_8N1                   XT_HAL_UART_PRESET(_8, _N, _1)   
#define XT_HAL_UART_8E1                   XT_HAL_UART_PRESET(_8, _E, _1)   
#define XT_HAL_UART_8O1                   XT_HAL_UART_PRESET(_8, _O, _1)   
#define XT_HAL_UART_8N2                   XT_HAL_UART_PRESET(_8, _N, _2)   
#define XT_HAL_UART_8E2                   XT_HAL_UART_PRESET(_8, _E, _2)   
#define XT_HAL_UART_8O2                   XT_HAL_UART_PRESET(_8, _O, _2)   
 
/* ==================== [Typedefs] ========================================== */

enum xt_hal_uart_event_id {
    XT_HAL_UART_EVENT_RX = 0x00, 
    XT_HAL_UART_EVENT_TX_DONE, 
};

typedef void (*xt_hal_uart_cb_t)(uint8_t uart_id, uint32_t event_id);
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_uart_setup(
    uint8_t uart_id, uint32_t preset, uint32_t baudrate,
    uint8_t tx_pin, uint8_t rx_pin);

xt_err_t xt_hal_uart_close(uint8_t uart_id);

xt_err_t xt_hal_uart_set_rx_buf(uint8_t uart_id, void *buffer, size_t size);

xt_err_t xt_hal_uart_set_tx_buf(uint8_t uart_id, void *buffer, size_t size);

xt_err_t xt_hal_uart_set_cb(uint8_t uart_id, xt_hal_uart_cb_t cb);

int32_t xt_hal_uart_tx_block(uint8_t uart_id, const void *tx_buffer, size_t size);

int32_t xt_hal_uart_tx_0copy(uint8_t uart_id, const void *tx_buffer, size_t size);

int32_t xt_hal_uart_tx(uint8_t uart_id, const void *tx_buffer, size_t size);

int32_t xt_hal_uart_rx(uint8_t uart_id, void *rx_buffer, size_t size);

int32_t xt_hal_uart_get_rx_count(uint8_t uart_id);

xt_err_t xt_hal_uart_flush_rx(uint8_t uart_id);

int32_t xt_hal_uart_get_tx_free(uint8_t uart_id);

bool xt_hal_uart_is_tx_busy(uint8_t uart_id);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_uart */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_UART_H__ */