Implement Tx only Flush (#3433)

stickbreaker · me-no-dev · commit 7d2632c024c7 · 2019-11-11T15:37:35.000+01:00
* add option to Flush() to only clear txQueue

Add the option to cause Flush() to just wait for tx data to clear the tx fifo and uart, leave the rx queue and rx fifo as is.

* support tx only flush()

* support tx only Flush()

* support txOnly for Flush()

* compatibility to Stream()

* compatibility for Stream()

* default value error

* default value error

* Update esp32-hal-uart.h

* Update esp32-hal-uart.c

* Update HardwareSerial.cpp

* sp

* correctly implement flushTxOnly()
diff --git a/cores/esp32/HardwareSerial.cpp b/cores/esp32/HardwareSerial.cpp
@@ -131,11 +131,16 @@ int HardwareSerial::read(void)
     return -1;
 }
 
-void HardwareSerial::flush()
+void HardwareSerial::flush(void)
 {
     uartFlush(_uart);
 }
 
+void HardwareSerial::flush(bool txOnly)
+{
+    uartFlushTxOnly(_uart, txOnly);
+}
+
 size_t HardwareSerial::write(uint8_t c)
 {
     uartWrite(_uart, c);
diff --git a/cores/esp32/HardwareSerial.h b/cores/esp32/HardwareSerial.h
@@ -63,6 +63,7 @@ class HardwareSerial: public Stream
     int peek(void);
     int read(void);
     void flush(void);
+    void flush( bool txOnly);
     size_t write(uint8_t);
     size_t write(const uint8_t *buffer, size_t size);
 
diff --git a/cores/esp32/esp32-hal-uart.c b/cores/esp32/esp32-hal-uart.c
@@ -327,24 +327,31 @@ void uartWriteBuf(uart_t* uart, const uint8_t * data, size_t len)
 }
 
 void uartFlush(uart_t* uart)
+{
+    uartFlushTxOnly(uart,false);
+}
+
+void uartFlushTxOnly(uart_t* uart, bool txOnly)
 {
     if(uart == NULL) {
         return;
     }
 
     UART_MUTEX_LOCK();
     while(uart->dev->status.txfifo_cnt || uart->dev->status.st_utx_out);
+    
+    if( !txOnly ){
+        //Due to hardware issue, we can not use fifo_rst to reset uart fifo.
+        //See description about UART_TXFIFO_RST and UART_RXFIFO_RST in <<esp32_technical_reference_manual>> v2.6 or later.
 
-    //Due to hardware issue, we can not use fifo_rst to reset uart fifo.
-    //See description about UART_TXFIFO_RST and UART_RXFIFO_RST in <<esp32_technical_reference_manual>> v2.6 or later.
+        // we read the data out and make `fifo_len == 0 && rd_addr == wr_addr`.
+        while(uart->dev->status.rxfifo_cnt != 0 || (uart->dev->mem_rx_status.wr_addr != uart->dev->mem_rx_status.rd_addr)) {
+            READ_PERI_REG(UART_FIFO_REG(uart->num));
+        }
 
-    // we read the data out and make `fifo_len == 0 && rd_addr == wr_addr`.
-    while(uart->dev->status.rxfifo_cnt != 0 || (uart->dev->mem_rx_status.wr_addr != uart->dev->mem_rx_status.rd_addr)) {
-        READ_PERI_REG(UART_FIFO_REG(uart->num));
+        xQueueReset(uart->queue);
     }
-
-    xQueueReset(uart->queue);
-
+    
     UART_MUTEX_UNLOCK();
 }
 
diff --git a/cores/esp32/esp32-hal-uart.h b/cores/esp32/esp32-hal-uart.h
@@ -63,6 +63,7 @@ void uartWrite(uart_t* uart, uint8_t c);
 void uartWriteBuf(uart_t* uart, const uint8_t * data, size_t len);
 
 void uartFlush(uart_t* uart);
+void uartFlushTxOnly(uart_t* uart, bool txOnly );
 
 void uartSetBaudRate(uart_t* uart, uint32_t baud_rate);
 uint32_t uartGetBaudRate(uart_t* uart);

Original file line number	Diff line number	Diff line change
`@@ -131,11 +131,16 @@ int HardwareSerial::read(void)`
`131`	`131`	`return -1;`
`132`	`132`	`}`
`133`	`133`
`134`		`-void HardwareSerial::flush()`
	`134`	`+void HardwareSerial::flush(void)`
`135`	`135`	`{`
`136`	`136`	`uartFlush(_uart);`
`137`	`137`	`}`
`138`	`138`
	`139`	`+void HardwareSerial::flush(bool txOnly)`
	`140`	`+{`
	`141`	`+ uartFlushTxOnly(_uart, txOnly);`
	`142`	`+}`
	`143`	`+`
`139`	`144`	`size_t HardwareSerial::write(uint8_t c)`
`140`	`145`	`{`
`141`	`146`	`uartWrite(_uart, c);`