Merge pull request #405 from pennam/fix-flush

Fix for Serial flush() returning before transmission has completed
arduino · Nov 29, 2024 · 03b4a91 · 03b4a91
2 parents 04d998d + 51e2905
commit 03b4a91
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 12 deletions.
diff --git a/cores/arduino/Serial.cpp b/cores/arduino/Serial.cpp
@@ -58,12 +58,14 @@ void UART::WrapperCallback(uart_callback_args_t *p_args) {
       {
           break;
       }
-      case UART_EVENT_TX_COMPLETE:
-      case UART_EVENT_TX_DATA_EMPTY:
+      case UART_EVENT_TX_COMPLETE: // This is call when the transmission is complete
       {
-        //uint8_t to_enqueue = uart_ptr->txBuffer.available() < uart_ptr->uart_ctrl.fifo_depth ? uart_ptr->txBuffer.available() : uart_ptr->uart_ctrl.fifo_depth;
-        //while (to_enqueue) {
-        uart_ptr->tx_done = true;
+        uart_ptr->tx_complete = true;
+        break;
+      }
+      case UART_EVENT_TX_DATA_EMPTY: // This is called when the buffer is empty
+      {                              // Last byte is transmitting, but ready for more data
+        uart_ptr->tx_empty = true;
         break;
       }
       case UART_EVENT_RX_CHAR:
@@ -87,6 +89,8 @@ UART::UART(int _pin_tx, int _pin_rx, int _pin_rts, int _pin_cts):
   rx_pin(_pin_rx),
   rts_pin(_pin_rts),
   cts_pin(_pin_cts),
+  tx_empty(true),
+  tx_complete(true),
   init_ok(false) {
 /* -------------------------------------------------------------------------- */    
   uart_cfg.txi_irq = FSP_INVALID_VECTOR;
@@ -109,9 +113,10 @@ bool UART::setUpUartIrqs(uart_cfg_t &cfg) {
 size_t UART::write(uint8_t c) {
 /* -------------------------------------------------------------------------- */  
   if(init_ok) {
-    tx_done = false;
+    tx_empty = false;
+    tx_complete = false;
     R_SCI_UART_Write(&uart_ctrl, &c, 1);
-    while (!tx_done) {}
+    while (!tx_empty) {}
     return 1;
   }
   else {
@@ -121,9 +126,10 @@ size_t UART::write(uint8_t c) {
 
 size_t  UART::write(uint8_t* c, size_t len) {
   if(init_ok) {
-    tx_done = false;
+    tx_empty = false;
+    tx_complete = false;
     R_SCI_UART_Write(&uart_ctrl, c, len);
-    while (!tx_done) {}
+    while (!tx_empty) {}
     return len;
   }
   else {
@@ -322,7 +328,7 @@ int UART::read() {
 /* -------------------------------------------------------------------------- */
 void UART::flush() {
 /* -------------------------------------------------------------------------- */  
-  while(txBuffer.available());
+  while(!tx_complete);
 }
 
 /* -------------------------------------------------------------------------- */
@@ -335,4 +341,4 @@ size_t UART::write_raw(uint8_t* c, size_t len) {
     i++;
   }
   return len;
-}
+}
diff --git a/cores/arduino/Serial.h b/cores/arduino/Serial.h
@@ -78,7 +78,8 @@ class UART : public arduino::HardwareSerial {
     arduino::SafeRingBufferN<SERIAL_BUFFER_SIZE> rxBuffer;
     arduino::SafeRingBufferN<SERIAL_BUFFER_SIZE> txBuffer;
 
-    volatile bool tx_done;
+    volatile bool tx_empty;
+    volatile bool tx_complete;
 
     sci_uart_instance_ctrl_t  uart_ctrl;
     uart_cfg_t                uart_cfg;