xc_drv_uart.h

浏览该文件的文档.

 
#ifndef __XC_UART_H__
#define __XC_UART_H__
 
/*-----------------------------------------------------------------------------------
                                       INCLUDE HEADE FILES
 ------------------------------------------------------------------------------------*/
#include <stdbool.h>
#include <stdio.h>
 
#include "ringbuffer.h"
#include "xc6xxx.h"
 
/*------------------------------------------------------------------------------------
                                            TypeDef
 -------------------------------------------------------------------------------------*/
typedef void (*uart_handler_callback)(uint8_t *buff, uint16_t len);
 
typedef enum
{
    UART_IT_Modem_Status            = 0x00, 
    UART_NO_Pending_INT             = 0x01, 
    UART_IT_THR_Empty               = 0x02, 
    UART_IT_Received_Data_Available = 0x04, 
    UART_IT_Receive_Line_Status     = 0x06, 
    UART_IT_Character_Timeout       = 0x0C, 
} UART_IT_TypeDef;
 
typedef struct
{
    uint32_t BaudRate;
 
    uint16_t WordLength;
 
    uint16_t StopBits;
 
    uint16_t Parity;
 
    uint16_t HardwareFlowControl;
 
} UART_InitCfg_t;
 
typedef struct
{
    uart_handler_callback uart_receive_cb;
} UART_Block_t;
 
/*------------------------------------------------------------------------------------
                                             Macros
 -------------------------------------------------------------------------------------*/
 
#define UART_IER_ERDA_ENABLE                   (0x1UL)
#define UART_IER_ERDA_DISABLE                  (0x0UL)
 
#define UART_IER_ETHEI_ENABLE                  (0x1UL)
#define UART_IER_ETHEI_DISABLE                 (0x0UL)
 
#define UART_IER_ETSI_ENABLE                   (0x1UL)
#define UART_IER_ETSI_DISABLE                  (0x0UL)
 
#define UART_IER_EMSI_ENABLE                   (0x1UL)
#define UART_IER_EMSI_DISABLE                  (0x0UL)
 
#define UART_IER_ETSI_ENABLE                   (0x1UL)
#define UART_IER_ETSI_DISABLE                  (0x0UL)
 
#define UART_IER_ETHSI_ENABLE                  (0x1UL)
#define UART_IER_ETHSI_DISABLE                 (0x0UL)
 
#define UART_IER_ERDAI_ENABLE                  (0x1UL)
#define UART_IER_ERDAI_DISABLE                 (0x0UL)
 
#define UART_IER_PTIME_ENABLE                  (0x1UL)
#define UART_IER_PTIME_DISABLE                 (0x0UL)
 
#define UART_IIR_IID_EMSI                      (0x0UL)
#define UART_IIR_IID_NO_IT                     (0x1UL)
#define UART_IIR_IID_ETHEI                     (0x02UL)
#define UART_IIR_IID_ERDAI                     (0x04UL)
#define UART_IIR_IID_ETSI                      (0x06UL)
#define UART_IIR_IID_BUSY                      (0x07UL)
#define UART_IIR_IID_TO                        (0xCUL)
 
#define UART_IIR_FS_ENABLE                     (0x3UL)
#define UART_IIR_FS_DISABLE                    (0x0UL)
 
#define UART_FCR_FIFO_ENABLE_ENABLE            (0x1UL)
#define UART_FCR_FIFO_ENABLE_DISABLE           (0x0UL)
 
#define UART_FCR_RCVR_FIFO_RESET_CLEAR         (0x1UL)
#define UART_FCR_RCVR_FIFO_RESET_NOT_CLEAR     (0x0UL)
 
#define UART_FCR_XMIT_FIFO_RESET_CLEAR         (0x1UL)
#define UART_FCR_XMIT_FIFO_RESET_NOT_CLEAR     (0x0UL)
 
#define UART_FCR_TX_EMPTY_TRIGGER_FIFO_EMPTY   (0x0UL)
#define UART_FCR_TX_EMPTY_TRIGGER_FIFO_2_BYTE  (0x1UL)
#define UART_FCR_TX_EMPTY_TRIGGER_FIFO_4_3     (0x2UL)
#define UART_FCR_TX_EMPTY_TRIGGER_FIFO_2_1     (0x3UL)
 
#define UART_FCR_RCVR_TRIGGER_FIFO_1_BYTE      (0x0UL)
#define UART_FCR_RCVR_TRIGGER_FIFO_4_1         (0x1UL)
#define UART_FCR_RCVR_TRIGGER_FIFO_2_1         (0x2UL)
#define UART_FCR_RCVR_TRIGGER_FIFO_LESS_2_BYTE (0x3UL)
 
#define UART_TCR_CLS_Pos                       (0UL)
#define UART_TCR_CLS_Msk                       (0x3UL)
#define UART_TCR_CLS_5BITS                     (0x0UL)
#define UART_TCR_CLS_6BITS                     (0x1UL)
#define UART_TCR_CLS_7BITS                     (0x2UL)
#define UART_TCR_CLS_8BITS                     (0x3UL)
 
#define UART_TCR_STOP_Pos                      (2UL)
#define UART_TCR_STOP_Msk                      (0x1UL)
#define UART_TCR_STOP_1BITS                    (0x0UL)
#define UART_TCR_STOP_1_5BITS                  (0x1UL)
 
#define UART_TCR_STOP_2BITS                    (0x1UL)
 
#define UART_TCR_PEN_DISABLE                   (0x0UL)
#define UART_TCR_PENS_ENABLE                   (0x1UL)
 
#define UART_TCR_EPS_ODD                       (0x0UL)
#define UART_TCR_EPS_EVEN                      (0x1UL)
 
#define UART_TCR_BREAK_STOP                    (0x1UL)
#define UART_TCR_BREAK_RECOVER                 (0x0UL)
 
#define UART_TCR_DLAB_DLLH_ENABLE              (0x1UL)
#define UART_TCR_DLAB_DLLH_DISABLE             (0x0UL)
 
#define UART_MCR_RTS_Msk                       (0x1UL)
#define UART_MCR_RTS_OUT_HIGH                  (0x1UL)
#define UART_MCR_RTS_OUT_LOW                   (0x0UL)
 
#define UART_MCR_AFCE_ENABLE                   (0x1UL)
#define UART_MCR_AFCE_DISABLE                  (0x0UL)
 
#define UART_TSR_DR_VALID                      (0x1UL)
#define UART_TSR_DR_INVALID                    (0x0UL)
 
#define UART_TSR_OE_VALID                      (0x1UL)
#define UART_TSR_OE_INVALID                    (0x0UL)
 
#define UART_TSR_PE_Pos                        (2UL)
#define UART_TSR_PE_Msk                        (0x1UL)
#define UART_TSR_PE_VALID                      (0x1UL)
#define UART_TSR_PE_INVALID                    (0x0UL)
 
#define UART_TSR_FE_VALID                      (0x1UL)
#define UART_TSR_FE_INVALID                    (0x0UL)
 
#define UART_TSR_BI_VALID                      (0x1UL)
#define UART_TSR_BI_INVALID                    (0x0UL)
 
#define UART_TSR_THRE_VALID                    (0x1UL)
#define UART_TSR_THRE_INVALID                  (0x0UL)
 
#define UART_TSR_RX_FIFO_ERROR_VALID           (0x1UL)
#define UART_TSR_RX_FIFO_ERROR_INVALID         (0x0UL)
 
#define UART_MSR_DCTS_CHANGE                   (0x1UL)
#define UART_MSR_DCTS_NO_CHANGE                (0x0UL)
 
#define UART_MSR_CTS_OUT_LOW                   (0x1UL)
#define UART_MSR_CTS_OUT_HIGH                  (0x0UL)
 
#define UART_USR_BUSY_BUSY                     (0x1UL)
#define UART_USR_BUSY_IDLE                     (0x0UL)
 
#define UART_NUM                               3
#define UART_BUFF_LEN                          64U
 
#define UART_DATA_5_BITS                       UART_TCR_CLS_5BITS
#define UART_DATA_6_BITS                       UART_TCR_CLS_6BITS
#define UART_DATA_7_BITS                       UART_TCR_CLS_7BITS
#define UART_DATA_8_BITS                       UART_TCR_CLS_8BITS
 
#define UART_STOP_1_BITS                       UART_TCR_STOP_1BITS
#define UART_STOP_1_5_BITS                     UART_TCR_STOP_1_5BITS
#define UART_STOP_2_BITS                       UART_TCR_STOP_2BITS
 
#define UART_HWFC_DISABLE                      UART_MCR_AFCE_DISABLE
#define UART_HWFC_ENABLE                       UART_MCR_AFCE_ENABLE
 
#define UART_PARITY_ENABLE                     UART_TCR_PENS_ENABLE
#define UART_PARITY_DISABLE                    UART_TCR_PEN_DISABLE
 
#define UART_PARITY_EVEN                       (UART_TCR_EPS_EVEN | UART_PARITY_ENABLE)
#define UART_PARITY_ODD                        (UART_TCR_EPS_ODD | UART_PARITY_ENABLE)
 
#define UART_BAUDRATE_2400                     (0x0120271CUL)
#define UART_BAUDRATE_4800                     (0x0240271CUL)
#define UART_BAUDRATE_9600                     (0x0480271CUL)
#define UART_BAUDRATE_12800                    (0x04802719UL)
#define UART_BAUDRATE_14400                    (0x04802718UL)
#define UART_BAUDRATE_19200                    (0x04802716UL)
#define UART_BAUDRATE_23040                    (0x04802715UL)
#define UART_BAUDRATE_38400                    (0x04802713UL)
#define UART_BAUDRATE_57600                    (0x04802712UL)
#define UART_BAUDRATE_115200                   (0x04802711UL)
#define UART_BAUDRATE_128000                   (0x030007D3UL)
#define UART_BAUDRATE_230400                   (0x09002711UL)
#define UART_BAUDRATE_256000                   (0x060007D3UL)
#define UART_BAUDRATE_460800                   (0x12002711UL)
#define UART_BAUDRATE_921600                   (0x24002711UL)
#define UART_BAUDRATE_1M                       (0x00100011UL)
 
/*------------------------------------------------------------------------------------
                                         Global Variables
 -------------------------------------------------------------------------------------*/
 
extern uint8_t __attribute__((aligned(4))) uart_txdmabuff[UART_BUFF_LEN];
extern uint8_t __attribute__((aligned(4))) uart_rxdmabuff[UART_BUFF_LEN];
 
/*------------------------------------------------------------------------------------
                                        Exported Functions
 -------------------------------------------------------------------------------------*/
 
void xc_uart_init(uint8_t reg_idx, UART_InitCfg_t *uart_cfg);
void xc_uart_enable_rx_it(uint8_t reg_idx);
void xc_uart_disable_rx_it(uint8_t reg_idx);
void xc_uart_send_byte(uint8_t reg_idx, uint8_t byte);
void xc_uart_send_data(uint8_t reg_idx, uint8_t *data, uint16_t len);
uint16_t xc_uart_receive_data(uint8_t reg_idx, uint8_t *data);
void xc_uart_register_receive_cb(uart_handler_callback uart_cb);
#endif /* __XC6xxx_HAL_UART_H__ */