123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229 |
- /*
- * ESPRSSIF MIT License
- *
- * Copyright (c) 2016 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
- *
- * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
- * it is free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
- * to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- */
- #ifndef UART_APP_H
- #define UART_APP_H
- #include "uart_register.h"
- #include "eagle_soc.h"
- #include "c_types.h"
- #define UART_TX_BUFFER_SIZE 256 //Ring buffer length of tx buffer
- #define UART_RX_BUFFER_SIZE 256 //Ring buffer length of rx buffer
- #define UART_BUFF_EN 0 //use uart buffer , FOR UART0
- #define UART_SELFTEST 0 //set 1:enable the loop test demo for uart buffer, FOR UART0
- #define UART_HW_RTS 0 //set 1: enable uart hw flow control RTS, PIN MTDO, FOR UART0
- #define UART_HW_CTS 0 //set1: enable uart hw flow contrl CTS , PIN MTCK, FOR UART0
- #define UART0 0
- #define UART1 1
- typedef enum {
- FIVE_BITS = 0x0,
- SIX_BITS = 0x1,
- SEVEN_BITS = 0x2,
- EIGHT_BITS = 0x3
- } UartBitsNum4Char;
- typedef enum {
- ONE_STOP_BIT = 0x1,
- ONE_HALF_STOP_BIT = 0x2,
- TWO_STOP_BIT = 0x3
- } UartStopBitsNum;
- typedef enum {
- NONE_BITS = 0x2,
- ODD_BITS = 1,
- EVEN_BITS = 0
- } UartParityMode;
- typedef enum {
- STICK_PARITY_DIS = 0,
- STICK_PARITY_EN = 1
- } UartExistParity;
- typedef enum {
- 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;
- typedef enum {
- 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;
- typedef enum {
- NONE_CTRL,
- HARDWARE_CTRL,
- XON_XOFF_CTRL
- } UartFlowCtrl;
- typedef enum {
- USART_HardwareFlowControl_None = 0x0,
- USART_HardwareFlowControl_RTS = 0x1,
- USART_HardwareFlowControl_CTS = 0x2,
- USART_HardwareFlowControl_CTS_RTS = 0x3
- } UART_HwFlowCtrl;
- typedef enum {
- EMPTY,
- UNDER_WRITE,
- WRITE_OVER
- } RcvMsgBuffState;
- typedef struct {
- uint32 RcvBuffSize;
- uint8 *pRcvMsgBuff;
- uint8 *pWritePos;
- uint8 *pReadPos;
- uint8 TrigLvl; //JLU: may need to pad
- RcvMsgBuffState BuffState;
- } RcvMsgBuff;
- typedef struct {
- uint32 TrxBuffSize;
- uint8 *pTrxBuff;
- } TrxMsgBuff;
- typedef enum {
- BAUD_RATE_DET,
- WAIT_SYNC_FRM,
- SRCH_MSG_HEAD,
- RCV_MSG_BODY,
- RCV_ESC_CHAR,
- } RcvMsgState;
- typedef struct {
- UartBautRate baut_rate;
- UartBitsNum4Char data_bits;
- UartExistParity exist_parity;
- UartParityMode parity;
- UartStopBitsNum stop_bits;
- UartFlowCtrl flow_ctrl;
- RcvMsgBuff rcv_buff;
- TrxMsgBuff trx_buff;
- RcvMsgState rcv_state;
- int received;
- int buff_uart_no; //indicate which uart use tx/rx buffer
- } UartDevice;
- void uart_init(UartBautRate uart0_br, UartBautRate uart1_br);
- void uart0_sendStr(const char *str);
- ///////////////////////////////////////
- #define UART_FIFO_LEN 128 //define the tx fifo length
- #define UART_TX_EMPTY_THRESH_VAL 0x10
- struct UartBuffer{
- uint32 UartBuffSize;
- uint8 *pUartBuff;
- uint8 *pInPos;
- uint8 *pOutPos;
- STATUS BuffState;
- uint16 Space; //remanent space of the buffer
- uint8 TcpControl;
- struct UartBuffer * nextBuff;
- };
- struct UartRxBuff{
- uint32 UartRxBuffSize;
- uint8 *pUartRxBuff;
- uint8 *pWritePos;
- uint8 *pReadPos;
- STATUS RxBuffState;
- uint32 Space; //remanent space of the buffer
- } ;
- typedef enum {
- RUN = 0,
- BLOCK = 1,
- } TCPState;
- //void ICACHE_FLASH_ATTR uart_test_rx();
- 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();
- #if UART_BUFF_EN
- 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();
- #endif
- void uart_rx_intr_enable(uint8 uart_no);
- void uart_rx_intr_disable(uint8 uart_no);
- void uart0_tx_buffer(uint8 *buf, uint16 len);
- //==============================================
- #define FUNC_UART0_CTS 4
- #define FUNC_U0CTS 4
- #define FUNC_U1TXD_BK 2
- #define UART_LINE_INV_MASK (0x3f<<19)
- 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); //do not use if tx flow control enabled
- 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);
- //==============================================
- #endif
|