driver/uart.h 文件参考

#include "uart_register.h"
#include "eagle_soc.h"
#include "c_types.h"

driver/uart.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

结构体
struct	RcvMsgBuff
struct	TrxMsgBuff
struct	UartDevice
struct	UartBuffer
struct	UartRxBuff

宏定义
#define	ESP_DEBUG_ON   1
#define	ESP_DEBUG(fmt,...)
#define	UART_TX_BUFFER_SIZE   256
#define	UART_RX_BUFFER_SIZE   256
#define	UART_BUFF_EN   1
#define	UART_SELFTEST   1
#define	UART_HW_RTS   0
#define	UART_HW_CTS   0
#define	UART0   0
#define	UART1   1
#define	UART_FIFO_LEN   128
#define	UART_TX_EMPTY_THRESH_VAL   0x10
#define	FUNC_UART0_CTS   4
#define	FUNC_U0CTS   4
#define	FUNC_U1TXD_BK   2
#define	UART_LINE_INV_MASK   (0x3f<<19)

枚举
enum	UartBitsNum4Char {   FIVE_BITS = 0x0, SIX_BITS = 0x1, SEVEN_BITS = 0x2, EIGHT_BITS = 0x3,   FIVE_BITS = 0x0, SIX_BITS = 0x1, SEVEN_BITS = 0x2, EIGHT_BITS = 0x3 }
enum	UartStopBitsNum {   ONE_STOP_BIT = 0x1, ONE_HALF_STOP_BIT = 0x2, TWO_STOP_BIT = 0x3, ONE_STOP_BIT = 0x1,   ONE_HALF_STOP_BIT = 0x2, TWO_STOP_BIT = 0x3 }
enum	UartParityMode {   NONE_BITS = 0x2, ODD_BITS = 1, EVEN_BITS = 0, NONE_BITS = 0x2,   ODD_BITS = 1, EVEN_BITS = 0 }
enum	UartExistParity { STICK_PARITY_DIS = 0, STICK_PARITY_EN = 1, STICK_PARITY_DIS = 0, STICK_PARITY_EN = 1 }
enum	UART_LineLevelInverse {   UART_None_Inverse = 0x0, UART_Rxd_Inverse = UART_RXD_INV, UART_CTS_Inverse = UART_CTS_INV, UART_Txd_Inverse = UART_TXD_INV,   UART_RTS_Inverse = UART_RTS_INV, UART_None_Inverse = 0x0, UART_Rxd_Inverse = UART_RXD_INV, UART_CTS_Inverse = UART_CTS_INV,   UART_Txd_Inverse = UART_TXD_INV, UART_RTS_Inverse = UART_RTS_INV }
enum	UartBautRate {   BIT_RATE_300 = 300, BIT_RATE_600 = 600, BIT_RATE_1200 = 1200, BIT_RATE_2400 = 2400,   BIT_RATE_4800 = 4800, BIT_RATE_9600 = 9600, BIT_RATE_19200 = 19200, BIT_RATE_38400 = 38400,   BIT_RATE_57600 = 57600, BIT_RATE_74880 = 74880, BIT_RATE_115200 = 115200, BIT_RATE_230400 = 230400,   BIT_RATE_460800 = 460800, BIT_RATE_921600 = 921600, BIT_RATE_1843200 = 1843200, BIT_RATE_3686400 = 3686400,   BIT_RATE_300 = 300, BIT_RATE_600 = 600, BIT_RATE_1200 = 1200, BIT_RATE_2400 = 2400,   BIT_RATE_4800 = 4800, BIT_RATE_9600 = 9600, BIT_RATE_19200 = 19200, BIT_RATE_38400 = 38400,   BIT_RATE_57600 = 57600, BIT_RATE_74880 = 74880, BIT_RATE_115200 = 115200, BIT_RATE_230400 = 230400,   BIT_RATE_460800 = 460800, BIT_RATE_921600 = 921600, BIT_RATE_1843200 = 1843200, BIT_RATE_3686400 = 3686400 }
enum	UartFlowCtrl {   NONE_CTRL, HARDWARE_CTRL, XON_XOFF_CTRL, NONE_CTRL,   HARDWARE_CTRL, XON_XOFF_CTRL }
enum	UART_HwFlowCtrl {   USART_HardwareFlowControl_None = 0x0, USART_HardwareFlowControl_RTS = 0x1, USART_HardwareFlowControl_CTS = 0x2, USART_HardwareFlowControl_CTS_RTS = 0x3,   USART_HardwareFlowControl_None = 0x0, USART_HardwareFlowControl_RTS = 0x1, USART_HardwareFlowControl_CTS = 0x2, USART_HardwareFlowControl_CTS_RTS = 0x3 }
enum	RcvMsgBuffState {   EMPTY, UNDER_WRITE, WRITE_OVER, EMPTY,   UNDER_WRITE, WRITE_OVER }
enum	RcvMsgState {   BAUD_RATE_DET, WAIT_SYNC_FRM, SRCH_MSG_HEAD, RCV_MSG_BODY,   RCV_ESC_CHAR, BAUD_RATE_DET, WAIT_SYNC_FRM, SRCH_MSG_HEAD,   RCV_MSG_BODY, RCV_ESC_CHAR }
enum	TCPState { RUN = 0, BLOCK = 1, RUN = 0, BLOCK = 1 }

函数
void	uart_init (UartBautRate uart0_br, UartBautRate uart1_br)
void	uart0_sendStr (const char *str)
STATUS	uart_tx_one_char (uint8 uart, uint8 TxChar)
STATUS	uart_tx_one_char_no_wait (uint8 uart, uint8 TxChar)
void	uart1_sendStr_no_wait (const char *str)
struct UartBuffer *	Uart_Buf_Init ()
LOCAL void	Uart_Buf_Cpy (struct UartBuffer *pCur, char *pdata, uint16 data_len)
void	uart_buf_free (struct UartBuffer *pBuff)
void	tx_buff_enq (char *pdata, uint16 data_len)
LOCAL void	tx_fifo_insert (struct UartBuffer *pTxBuff, uint8 data_len, uint8 uart_no)
void	tx_start_uart_buffer (uint8 uart_no)
uint16	rx_buff_deq (char *pdata, uint16 data_len)
void	Uart_rx_buff_enq ()
void	uart_rx_intr_enable (uint8 uart_no)
void	uart_rx_intr_disable (uint8 uart_no)
void	uart0_tx_buffer (uint8 *buf, uint16 len)
void	uart1_tx_buffer (uint8 *buf, uint16 len)
void	UART_SetWordLength (uint8 uart_no, UartBitsNum4Char len)
void	UART_SetStopBits (uint8 uart_no, UartStopBitsNum bit_num)
void	UART_SetLineInverse (uint8 uart_no, UART_LineLevelInverse inverse_mask)
void	UART_SetParity (uint8 uart_no, UartParityMode Parity_mode)
void	UART_SetBaudrate (uint8 uart_no, uint32 baud_rate)
void	UART_SetFlowCtrl (uint8 uart_no, UART_HwFlowCtrl flow_ctrl, uint8 rx_thresh)
void	UART_WaitTxFifoEmpty (uint8 uart_no, uint32 time_out_us)
void	UART_ResetFifo (uint8 uart_no)
void	UART_ClearIntrStatus (uint8 uart_no, uint32 clr_mask)
void	UART_SetIntrEna (uint8 uart_no, uint32 ena_mask)
void	UART_SetPrintPort (uint8 uart_no)
bool	UART_CheckOutputFinished (uint8 uart_no, uint32 time_out_us)

宏定义说明

#define ESP_DEBUG_ON   1

#define ESP_DEBUG	(		fmt,
			...
	)

值:

do                                                      \
    {                                                       \
        if (ESP_DEBUG_ON)                                   \
            os_printf("<<-ESP-DEBUG->> File: %20s"          \
                   " | FUNC: %25s"                            \
                   " | LINE:[%5d] > " fmt "\n",              \
                   __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__);  \
    } while (0)

#define UART_TX_BUFFER_SIZE   256

#define UART_RX_BUFFER_SIZE   256

#define UART_BUFF_EN   1

#define UART_SELFTEST   1

#define UART_HW_RTS   0

#define UART_HW_CTS   0

#define UART0   0

#define UART1   1

#define UART_FIFO_LEN   128

#define UART_TX_EMPTY_THRESH_VAL   0x10

#define FUNC_UART0_CTS   4

#define FUNC_U0CTS   4

#define FUNC_U1TXD_BK   2

#define UART_LINE_INV_MASK   (0x3f<<19)

枚举类型说明

enum UartBitsNum4Char

枚举值
FIVE_BITS
SIX_BITS
SEVEN_BITS
EIGHT_BITS
FIVE_BITS
SIX_BITS
SEVEN_BITS
EIGHT_BITS

             {
    FIVE_BITS = 0x0,
    SIX_BITS = 0x1,
    SEVEN_BITS = 0x2,
    EIGHT_BITS = 0x3
} UartBitsNum4Char;

enum UartStopBitsNum

枚举值
ONE_STOP_BIT
ONE_HALF_STOP_BIT
TWO_STOP_BIT
ONE_STOP_BIT
ONE_HALF_STOP_BIT
TWO_STOP_BIT

             {
    ONE_STOP_BIT             = 0x1,
    ONE_HALF_STOP_BIT        = 0x2,
    TWO_STOP_BIT             = 0x3
} UartStopBitsNum;

enum UartParityMode

枚举值
NONE_BITS
ODD_BITS
EVEN_BITS
NONE_BITS
ODD_BITS
EVEN_BITS

             {
    NONE_BITS = 0x2,
    ODD_BITS   = 1,
    EVEN_BITS = 0
} UartParityMode;

enum UartExistParity

枚举值
STICK_PARITY_DIS
STICK_PARITY_EN
STICK_PARITY_DIS
STICK_PARITY_EN

             {
    STICK_PARITY_DIS   = 0,
    STICK_PARITY_EN    = 1
} UartExistParity;

enum UART_LineLevelInverse

枚举值
UART_None_Inverse
UART_Rxd_Inverse
UART_CTS_Inverse
UART_Txd_Inverse
UART_RTS_Inverse
UART_None_Inverse
UART_Rxd_Inverse
UART_CTS_Inverse
UART_Txd_Inverse
UART_RTS_Inverse

             {
    UART_None_Inverse = 0x0,
    UART_Rxd_Inverse = UART_RXD_INV,
    UART_CTS_Inverse = UART_CTS_INV,
    UART_Txd_Inverse = UART_TXD_INV,
    UART_RTS_Inverse = UART_RTS_INV,
} UART_LineLevelInverse;

enum UartBautRate

枚举值
BIT_RATE_300
BIT_RATE_600
BIT_RATE_1200
BIT_RATE_2400
BIT_RATE_4800
BIT_RATE_9600
BIT_RATE_19200
BIT_RATE_38400
BIT_RATE_57600
BIT_RATE_74880
BIT_RATE_115200
BIT_RATE_230400
BIT_RATE_460800
BIT_RATE_921600
BIT_RATE_1843200
BIT_RATE_3686400
BIT_RATE_300
BIT_RATE_600
BIT_RATE_1200
BIT_RATE_2400
BIT_RATE_4800
BIT_RATE_9600
BIT_RATE_19200
BIT_RATE_38400
BIT_RATE_57600
BIT_RATE_74880
BIT_RATE_115200
BIT_RATE_230400
BIT_RATE_460800
BIT_RATE_921600
BIT_RATE_1843200
BIT_RATE_3686400

             {
    BIT_RATE_300 = 300,
    BIT_RATE_600 = 600,
    BIT_RATE_1200 = 1200,
    BIT_RATE_2400 = 2400,
    BIT_RATE_4800 = 4800,
    BIT_RATE_9600   = 9600,
    BIT_RATE_19200  = 19200,
    BIT_RATE_38400  = 38400,
    BIT_RATE_57600  = 57600,
    BIT_RATE_74880  = 74880,
    BIT_RATE_115200 = 115200,
    BIT_RATE_230400 = 230400,
    BIT_RATE_460800 = 460800,
    BIT_RATE_921600 = 921600,
    BIT_RATE_1843200 = 1843200,
    BIT_RATE_3686400 = 3686400,
} UartBautRate;

enum UartFlowCtrl

枚举值
NONE_CTRL
HARDWARE_CTRL
XON_XOFF_CTRL
NONE_CTRL
HARDWARE_CTRL
XON_XOFF_CTRL

             {
    NONE_CTRL,
    HARDWARE_CTRL,
    XON_XOFF_CTRL
} UartFlowCtrl;

enum UART_HwFlowCtrl

枚举值
USART_HardwareFlowControl_None
USART_HardwareFlowControl_RTS
USART_HardwareFlowControl_CTS
USART_HardwareFlowControl_CTS_RTS
USART_HardwareFlowControl_None
USART_HardwareFlowControl_RTS
USART_HardwareFlowControl_CTS
USART_HardwareFlowControl_CTS_RTS

             {
    USART_HardwareFlowControl_None = 0x0,
    USART_HardwareFlowControl_RTS = 0x1,
    USART_HardwareFlowControl_CTS = 0x2,
    USART_HardwareFlowControl_CTS_RTS = 0x3
} UART_HwFlowCtrl;

enum RcvMsgBuffState

枚举值
EMPTY
UNDER_WRITE
WRITE_OVER
EMPTY
UNDER_WRITE
WRITE_OVER

             {
    EMPTY,
    UNDER_WRITE,
    WRITE_OVER
} RcvMsgBuffState;

enum RcvMsgState

枚举值
BAUD_RATE_DET
WAIT_SYNC_FRM
SRCH_MSG_HEAD
RCV_MSG_BODY
RCV_ESC_CHAR
BAUD_RATE_DET
WAIT_SYNC_FRM
SRCH_MSG_HEAD
RCV_MSG_BODY
RCV_ESC_CHAR

             {
    BAUD_RATE_DET,
    WAIT_SYNC_FRM,
    SRCH_MSG_HEAD,
    RCV_MSG_BODY,
    RCV_ESC_CHAR,
} RcvMsgState;

enum TCPState

枚举值
RUN
BLOCK
RUN
BLOCK

             {
    RUN = 0,
    BLOCK = 1,
} TCPState;

函数说明

void uart_init	(	UartBautRate	uart0_br,
		UartBautRate	uart1_br
	)

{
    /*this is a example to process uart data from task,please change the priority to fit your application task if exists*/
    system_os_task(uart_recvTask, uart_recvTaskPrio, uart_recvTaskQueue, uart_recvTaskQueueLen);  //demo with a task to process the uart data
    
    UartDev.baut_rate = uart0_br;
    uart_config(UART0);
    UartDev.baut_rate = uart1_br;
    uart_config(UART1);
    ETS_UART_INTR_ENABLE();
    
    #if UART_BUFF_EN
    pTxBuffer = Uart_Buf_Init(UART_TX_BUFFER_SIZE);
    pRxBuffer = Uart_Buf_Init(UART_RX_BUFFER_SIZE);
    #endif


    /*option 1: use default print, output from uart0 , will wait some time if fifo is full */
    //do nothing...

    /*option 2: output from uart1,uart1 output will not wait , just for output debug info */
    /*os_printf output uart data via uart1(GPIO2)*/
    //os_install_putc1((void *)uart1_write_char);    //use this one to output debug information via uart1 //

    /*option 3: output from uart0 will skip current byte if fifo is full now... */
    /*see uart0_write_char_no_wait:you can output via a buffer or output directly */
    /*os_printf output uart data via uart0 or uart buffer*/
    //os_install_putc1((void *)uart0_write_char_no_wait);  //use this to print via uart0
    
    #if UART_SELFTEST&UART_BUFF_EN
    os_timer_disarm(&buff_timer_t);
    os_timer_setfn(&buff_timer_t, uart_test_rx , NULL);   //a demo to process the data in uart rx buffer
    os_timer_arm(&buff_timer_t,10,1);
    #endif
}

这是这个函数的调用关系图:

void uart0_sendStr

(

const char *

str

)

{
    while(*str){
        uart_tx_one_char(UART0, *str++);
    }
}

STATUS uart_tx_one_char	(	uint8	uart,
		uint8	TxChar
	)

{
    while (true){
        uint32 fifo_cnt = READ_PERI_REG(UART_STATUS(uart)) & (UART_TXFIFO_CNT<<UART_TXFIFO_CNT_S);
        if ((fifo_cnt >> UART_TXFIFO_CNT_S & UART_TXFIFO_CNT) < 126) {
            break;
        }
    }
    WRITE_PERI_REG(UART_FIFO(uart) , TxChar);
    return OK;
}

STATUS uart_tx_one_char_no_wait	(	uint8	uart,
		uint8	TxChar
	)

{
    uint8 fifo_cnt = (( READ_PERI_REG(UART_STATUS(uart))>>UART_TXFIFO_CNT_S)& UART_TXFIFO_CNT);
    if (fifo_cnt < 126) {
        WRITE_PERI_REG(UART_FIFO(uart) , TxChar);
    }
    return OK;
}

void uart1_sendStr_no_wait

(

const char *

str

)

{
    while(*str){
        uart_tx_one_char_no_wait(UART1, *str++);
    }
}

struct UartBuffer* Uart_Buf_Init

(

)

这是这个函数的调用关系图:

LOCAL void Uart_Buf_Cpy	(	struct UartBuffer *	pCur,
		char *	pdata,
		uint16	data_len
	)

void uart_buf_free

(

struct UartBuffer *

pBuff

)

void tx_buff_enq	(	char *	pdata,
		uint16	data_len
	)

这是这个函数的调用关系图:

LOCAL void tx_fifo_insert	(	struct UartBuffer *	pTxBuff,
		uint8	data_len,
		uint8	uart_no
	)

void tx_start_uart_buffer

(

uint8

uart_no

)

这是这个函数的调用关系图:

uint16 rx_buff_deq	(	char *	pdata,
		uint16	data_len
	)

void Uart_rx_buff_enq

(

)

这是这个函数的调用关系图:

void uart_rx_intr_enable

(

uint8

uart_no

)

{
#if 1
    SET_PERI_REG_MASK(UART_INT_ENA(uart_no), UART_RXFIFO_FULL_INT_ENA|UART_RXFIFO_TOUT_INT_ENA);
#else
    ETS_UART_INTR_ENABLE();
#endif
}

void uart_rx_intr_disable

(

uint8

uart_no

)

{
#if 1
    CLEAR_PERI_REG_MASK(UART_INT_ENA(uart_no), UART_RXFIFO_FULL_INT_ENA|UART_RXFIFO_TOUT_INT_ENA);
#else
    ETS_UART_INTR_DISABLE();
#endif
}

void uart0_tx_buffer	(	uint8 *	buf,
		uint16	len
	)

{
    uint16 i;
    for (i = 0; i < len; i++)
    {
        uart_tx_one_char(UART0, buf[i]);
    }
}

void uart1_tx_buffer	(	uint8 *	buf,
		uint16	len
	)

{
    uint16 i;
    for (i = 0; i < len; i++)
    {
        uart_tx_one_char(UART1, buf[i]);
    }
}

函数调用图:

这是这个函数的调用关系图:

void UART_SetWordLength	(	uint8	uart_no,
		UartBitsNum4Char	len
	)

{
    SET_PERI_REG_BITS(UART_CONF0(uart_no),UART_BIT_NUM,len,UART_BIT_NUM_S);
}

void UART_SetStopBits	(	uint8	uart_no,
		UartStopBitsNum	bit_num
	)

{
    SET_PERI_REG_BITS(UART_CONF0(uart_no),UART_STOP_BIT_NUM,bit_num,UART_STOP_BIT_NUM_S);
}

void UART_SetLineInverse	(	uint8	uart_no,
		UART_LineLevelInverse	inverse_mask
	)

{
    CLEAR_PERI_REG_MASK(UART_CONF0(uart_no), UART_LINE_INV_MASK);
    SET_PERI_REG_MASK(UART_CONF0(uart_no), inverse_mask);
}

void UART_SetParity	(	uint8	uart_no,
		UartParityMode	Parity_mode
	)

{
    CLEAR_PERI_REG_MASK(UART_CONF0(uart_no), UART_PARITY |UART_PARITY_EN);
    if(Parity_mode==NONE_BITS){
    }else{
        SET_PERI_REG_MASK(UART_CONF0(uart_no), Parity_mode|UART_PARITY_EN);
    }
}

void UART_SetBaudrate	(	uint8	uart_no,
		uint32	baud_rate
	)

{
    uart_div_modify(uart_no, UART_CLK_FREQ /baud_rate);
}

void UART_SetFlowCtrl	(	uint8	uart_no,
		UART_HwFlowCtrl	flow_ctrl,
		uint8	rx_thresh
	)

{
    if(flow_ctrl&USART_HardwareFlowControl_RTS){
        PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTDO_U, FUNC_U0RTS);
        SET_PERI_REG_BITS(UART_CONF1(uart_no),UART_RX_FLOW_THRHD,rx_thresh,UART_RX_FLOW_THRHD_S);
        SET_PERI_REG_MASK(UART_CONF1(uart_no), UART_RX_FLOW_EN);
    }else{
        CLEAR_PERI_REG_MASK(UART_CONF1(uart_no), UART_RX_FLOW_EN);
    }
    if(flow_ctrl&USART_HardwareFlowControl_CTS){
        PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTCK_U, FUNC_UART0_CTS);
        SET_PERI_REG_MASK(UART_CONF0(uart_no), UART_TX_FLOW_EN);
    }else{
        CLEAR_PERI_REG_MASK(UART_CONF0(uart_no), UART_TX_FLOW_EN);
    }
}

void UART_WaitTxFifoEmpty	(	uint8	uart_no,
		uint32	time_out_us
	)

{
    uint32 t_s = system_get_time();
    while (READ_PERI_REG(UART_STATUS(uart_no)) & (UART_TXFIFO_CNT << UART_TXFIFO_CNT_S)){
        
        if(( system_get_time() - t_s )> time_out_us){
            break;
        }
    WRITE_PERI_REG(0X60000914, 0X73);//WTD

    }
}

void UART_ResetFifo

(

uint8

uart_no

)

{
    SET_PERI_REG_MASK(UART_CONF0(uart_no), UART_RXFIFO_RST | UART_TXFIFO_RST);
    CLEAR_PERI_REG_MASK(UART_CONF0(uart_no), UART_RXFIFO_RST | UART_TXFIFO_RST);
}

void UART_ClearIntrStatus	(	uint8	uart_no,
		uint32	clr_mask
	)

{
    WRITE_PERI_REG(UART_INT_CLR(uart_no), clr_mask);
}

void UART_SetIntrEna	(	uint8	uart_no,
		uint32	ena_mask
	)

{
    SET_PERI_REG_MASK(UART_INT_ENA(uart_no), ena_mask);
}

void UART_SetPrintPort

(

uint8

uart_no

)

{
    if(uart_no==1){
        os_install_putc1(uart1_write_char);
    }else{
        /*option 1: do not wait if uart fifo is full,drop current character*/
        os_install_putc1(uart0_write_char_no_wait);
    /*option 2: wait for a while if uart fifo is full*/
    os_install_putc1(uart0_write_char);
    }
}

这是这个函数的调用关系图:

bool UART_CheckOutputFinished	(	uint8	uart_no,
		uint32	time_out_us
	)

{
    uint32 t_start = system_get_time();
    uint8 tx_fifo_len;
    uint32 tx_buff_len;
    while(1){
        tx_fifo_len =( (READ_PERI_REG(UART_STATUS(uart_no))>>UART_TXFIFO_CNT_S)&UART_TXFIFO_CNT);
        if(pTxBuffer){
            tx_buff_len = ((pTxBuffer->UartBuffSize)-(pTxBuffer->Space));
        }else{
            tx_buff_len = 0;
        }
        
        if( tx_fifo_len==0 && tx_buff_len==0){
            return TRUE;
        }
        if( system_get_time() - t_start > time_out_us){
            return FALSE;
        }
    WRITE_PERI_REG(0X60000914, 0X73);//WTD
    }    
}