Update esp32-hal-uart.c

Author: Jason2866

cores/esp32/esp32-hal-uart.c

@@ -34,7 +34,9 @@ struct uart_struct_t {
     uint8_t num;
     bool has_peek;
     uint8_t peek_byte;
-
+    QueueHandle_t uart_event_queue;
+    void (*onReceive)(void);
+    TaskHandle_t envent_task;
 };
 
 #if CONFIG_DISABLE_HAL_LOCKS
@@ -43,12 +45,12 @@ struct uart_struct_t {
 #define UART_MUTEX_UNLOCK()
 
 static uart_t _uart_bus_array[] = {
-    {0, false, 0},
+    {0, false, 0, NULL, NULL, NULL},
 #if SOC_UART_NUM > 1
-    {1, false, 0},
+    {1, false, 0, NULL, NULL, NULL},
 #endif
 #if SOC_UART_NUM > 2
-    {2, false, 0},
+    {2, false, 0, NULL, NULL, NULL},
 #endif
 };
 
@@ -58,20 +60,20 @@ static uart_t _uart_bus_array[] = {
 #define UART_MUTEX_UNLOCK()  xSemaphoreGive(uart->lock)
 
 static uart_t _uart_bus_array[] = {
-    {NULL, 0, false, 0},
+    {NULL, 0, false, 0, NULL, NULL, NULL},
 #if SOC_UART_NUM > 1
-    {NULL, 1, false, 0},
+    {NULL, 1, false, 0, NULL, NULL, NULL},
 #endif
 #if SOC_UART_NUM > 2
-    {NULL, 2, false, 0},
+    {NULL, 2, false, 0, NULL, NULL, NULL},
 #endif
 };
 
 #endif
 
 // solves issue https://github.com/espressif/arduino-esp32/issues/6032
 // baudrate must be multiplied when CPU Frequency is lower than APB 80MHz
-uint32_t _get_effective_baudrate(uint32_t baudrate) 
+uint32_t _get_effective_baudrate(uint32_t baudrate)
 {
     uint32_t Freq = getApbFrequency()/1000000;
     if (Freq < 80) {
@@ -82,7 +84,68 @@ uint32_t _get_effective_baudrate(uint32_t baudrate)
     }
 }
 
-bool uartIsDriverInstalled(uart_t* uart) 
+
+void uartOnReceive(uart_t* uart, void(*function)(void))
+{
+    if(uart == NULL || function == NULL) {
+        return;
+    }
+    UART_MUTEX_LOCK();
+    uart->onReceive = function;
+    UART_MUTEX_UNLOCK();
+}
+
+
+static void uart_event_task(void *args)
+{
+    uart_t* uart = (uart_t *)args;
+    uart_event_t event;
+    for(;;) {
+        //Waiting for UART event.
+        if(xQueueReceive(uart->uart_event_queue, (void * )&event, (portTickType)portMAX_DELAY)) {
+            switch(event.type) {
+                //Event of UART receving data
+                case UART_DATA:
+                    UART_MUTEX_LOCK();
+                    if(uart->onReceive) uart->onReceive();
+                    UART_MUTEX_UNLOCK();
+                    break;
+                //Event of HW FIFO overflow detected
+                case UART_FIFO_OVF:
+                    log_w("UART%d FIFO Overflow. Flushing data. Consider adding Flow Control to your Application.", uart->num);
+                    uart_flush_input(uart->num);
+                    xQueueReset(uart->uart_event_queue);
+                    break;
+                //Event of UART ring buffer full
+                case UART_BUFFER_FULL:
+                    log_w("UART%d Buffer Full. Flushing data. Consider encreasing your buffer size of your Application.", uart->num);
+                    uart_flush_input(uart->num);
+                    xQueueReset(uart->uart_event_queue);
+                    break;
+                //Event of UART RX break detected
+                case UART_BREAK:
+                    log_w("UART%d RX break.", uart->num);
+                    break;
+                //Event of UART parity check error
+                case UART_PARITY_ERR:
+                    log_w("UART%d parity error.", uart->num);
+                    break;
+                //Event of UART frame error
+                case UART_FRAME_ERR:
+                    log_w("UART%d frame error.", uart->num);
+                    break;
+                //Others
+                default:
+                    log_w("UART%d unknown event type %d.", uart->num, event.type);
+                    break;
+            }
+        }
+    }
+    vTaskDelete(NULL);
+}
+
+
+bool uartIsDriverInstalled(uart_t* uart)
 {
     if(uart == NULL) {
         return 0;
@@ -100,9 +163,9 @@ void uartSetPins(uart_t* uart, uint8_t rxPin, uint8_t txPin)
         return;
     }
     UART_MUTEX_LOCK();
-    ESP_ERROR_CHECK(uart_set_pin(uart->num, txPin, rxPin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE)); 
+    ESP_ERROR_CHECK(uart_set_pin(uart->num, txPin, rxPin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE));
     UART_MUTEX_UNLOCK();
-    
+
 }
 
 
@@ -143,14 +206,20 @@ uart_t* uartBegin(uint8_t uart_nr, uint32_t baudrate, uint32_t config, int8_t rx
     uart_config.source_clk = UART_SCLK_APB;
 
 
-    ESP_ERROR_CHECK(uart_driver_install(uart_nr, 2*queueLen, 0, 0, NULL, 0));
+    ESP_ERROR_CHECK(uart_driver_install(uart_nr, 2*queueLen, 0, 20, &(uart->uart_event_queue), 0));
     ESP_ERROR_CHECK(uart_param_config(uart_nr, &uart_config));
     ESP_ERROR_CHECK(uart_set_pin(uart_nr, txPin, rxPin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE));
 
-    // Is it right or the idea is to swap rx and tx pins? 
+    // Is it right or the idea is to swap rx and tx pins?
     if (inverted) {
         // invert signal for both Rx and Tx
-        ESP_ERROR_CHECK(uart_set_line_inverse(uart_nr, UART_SIGNAL_TXD_INV | UART_SIGNAL_RXD_INV));    
+        ESP_ERROR_CHECK(uart_set_line_inverse(uart_nr, UART_SIGNAL_TXD_INV | UART_SIGNAL_RXD_INV));
+    }
+
+    // Creating UART event Task
+    xTaskCreate(uart_event_task, "uart_event_task", 2048, uart, configMAX_PRIORITIES - 1, &(uart->envent_task));
+    if (!uart->envent_task) {
+        log_e(" -- UART%d Event Task not Created!", uart_nr);
     }
 
     UART_MUTEX_UNLOCK();
@@ -164,9 +233,14 @@ void uartEnd(uart_t* uart)
     if(uart == NULL) {
         return;
     }
-   
+
     UART_MUTEX_LOCK();
     uart_driver_delete(uart->num);
+    if (uart->envent_task) {
+        vTaskDelete(uart->envent_task);
+        uart->envent_task = NULL;
+        uart->onReceive = NULL;
+    }
     UART_MUTEX_UNLOCK();
 }
 
@@ -176,13 +250,13 @@ void uartSetRxInvert(uart_t* uart, bool invert)
     if (uart == NULL)
         return;
 #if 0
-    // POTENTIAL ISSUE :: original code only set/reset rxd_inv bit 
+    // POTENTIAL ISSUE :: original code only set/reset rxd_inv bit
     // IDF or LL set/reset the whole inv_mask!
     if (invert)
         ESP_ERROR_CHECK(uart_set_line_inverse(uart->num, UART_SIGNAL_RXD_INV));
     else
         ESP_ERROR_CHECK(uart_set_line_inverse(uart->num, UART_SIGNAL_INV_DISABLE));
-    
+
 #else
     // this implementation is better over IDF API because it only affects RXD
     // this is supported in ESP32, ESP32-S2 and ESP32-C3
@@ -191,7 +265,7 @@ void uartSetRxInvert(uart_t* uart, bool invert)
         hw->conf0.rxd_inv = 1;
     else
         hw->conf0.rxd_inv = 0;
-#endif 
+#endif
 }
 
 
@@ -217,7 +291,7 @@ uint32_t uartAvailableForWrite(uart_t* uart)
         return 0;
     }
     UART_MUTEX_LOCK();
-    uint32_t available =  uart_ll_get_txfifo_len(UART_LL_GET_HW(uart->num));  
+    uint32_t available =  uart_ll_get_txfifo_len(UART_LL_GET_HW(uart->num));
     UART_MUTEX_UNLOCK();
     return available;
 }
@@ -301,7 +375,7 @@ void uartFlushTxOnly(uart_t* uart, bool txOnly)
     if(uart == NULL) {
         return;
     }
-    
+
     UART_MUTEX_LOCK();
     while(!uart_ll_is_tx_idle(UART_LL_GET_HW(uart->num)));
 
@@ -414,7 +488,7 @@ int log_printf(const char *format, ...)
         xSemaphoreTake(_uart_bus_array[s_uart_debug_nr].lock, portMAX_DELAY);
     }
 #endif
-    
+
     vsnprintf(temp, len+1, format, arg);
     ets_printf("%s", temp);
 
@@ -491,22 +565,22 @@ unsigned long uartBaudrateDetect(uart_t *uart, bool flg)
  * To start detection of baud rate with the uart the auto_baud.en bit needs to be cleared and set. The bit period is 
  * detected calling uartBadrateDetect(). The raw baudrate is computed using the UART_CLK_FREQ. The raw baudrate is 
  * rounded to the closed real baudrate.
- * 
+ *
  * ESP32-C3 reports wrong baud rate detection as shown below:
- * 
+ *
  * This will help in a future recall for the C3.
  * Baud Sent:          Baud Read:
  *  300        -->       19536
  * 2400        -->       19536
- * 4800        -->       19536 
- * 9600        -->       28818 
+ * 4800        -->       19536
+ * 9600        -->       28818
  * 19200       -->       57678
  * 38400       -->       115440
  * 57600       -->       173535
  * 115200      -->       347826
  * 230400      -->       701754
- * 
- * 
+ *
+ *
 */
 void uartStartDetectBaudrate(uart_t *uart) {
     if(uart == NULL) {
@@ -516,10 +590,10 @@ void uartStartDetectBaudrate(uart_t *uart) {
     uart_dev_t *hw = UART_LL_GET_HW(uart->num);
 
 #ifdef CONFIG_IDF_TARGET_ESP32C3
-    
+
     // ESP32-C3 requires further testing
-    // Baud rate detection returns wrong values 
-   
+    // Baud rate detection returns wrong values
+
     log_e("ESP32-C3 baud rate detection is not supported.");
     return;
 
@@ -535,7 +609,7 @@ void uartStartDetectBaudrate(uart_t *uart) {
     hw->auto_baud.en = 1;
 #endif
 }
- 
+
 unsigned long
 uartDetectBaudrate(uart_t *uart)
 {