fix(UART): sets the correct uart clock source when using begin(baudrate) (espressif#11122)

* fix(uart): uart begin does not set the clock source when baudrate changes

* fix(uart): returns success on baud rate change operation

* fix(code): uart typo - missing ( in the code

* fix(uart): replacing mutex lock to avoid double lock

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: Lucas Saavedra Vaz <[email protected]>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: 3 people

cores/esp32/esp32-hal-uart.c

@@ -585,17 +585,11 @@ uart_t *uartBegin(
       uartEnd(uart_nr);
     } else {
       bool retCode = true;
-      UART_MUTEX_LOCK();
       //User may just want to change some parameters, such as baudrate, data length, parity, stop bits or pins
       if (uart->_baudrate != baudrate) {
-        if (ESP_OK != uart_set_baudrate(uart_nr, baudrate)) {
-          log_e("UART%d changing baudrate failed.", uart_nr);
-          retCode = false;
-        } else {
-          log_v("UART%d changed baudrate to %d", uart_nr, baudrate);
-          uart->_baudrate = baudrate;
-        }
+        retCode = uartSetBaudRate(uart, baudrate);
       }
+      UART_MUTEX_LOCK();
       uart_word_length_t data_bits = (config & 0xc) >> 2;
       uart_parity_t parity = config & 0x3;
       uart_stop_bits_t stop_bits = (config & 0x30) >> 4;
@@ -972,10 +966,11 @@ void uartFlushTxOnly(uart_t *uart, bool txOnly) {
   UART_MUTEX_UNLOCK();
 }
 
-void uartSetBaudRate(uart_t *uart, uint32_t baud_rate) {
+bool uartSetBaudRate(uart_t *uart, uint32_t baud_rate) {
   if (uart == NULL) {
-    return;
+    return false;
   }
+  bool retCode = true;
   UART_MUTEX_LOCK();
 #if SOC_UART_SUPPORT_XTAL_CLK  // ESP32-S3, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-H2 and ESP32-P4
   soc_module_clk_t newClkSrc = UART_SCLK_XTAL;
@@ -993,12 +988,14 @@ void uartSetBaudRate(uart_t *uart, uint32_t baud_rate) {
   uart_ll_set_sclk(UART_LL_GET_HW(uart->num), newClkSrc);
 #endif
   if (uart_set_baudrate(uart->num, baud_rate) == ESP_OK) {
-    log_v("Setting UART%d baud rate to %d.", uart->num, baud_rate);
+    log_v("Setting UART%d baud rate to %ld.", uart->num, baud_rate);
     uart->_baudrate = baud_rate;
   } else {
-    log_e("Setting UART%d baud rate to %d has failed.", uart->num, baud_rate);
+    retCode = false;
+    log_e("Setting UART%d baud rate to %ld has failed.", uart->num, baud_rate);
   }
   UART_MUTEX_UNLOCK();
+  return retCode;
 }
 
 uint32_t uartGetBaudRate(uart_t *uart) {

cores/esp32/esp32-hal-uart.h

@@ -58,7 +58,7 @@ 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);
+bool uartSetBaudRate(uart_t *uart, uint32_t baud_rate);
 uint32_t uartGetBaudRate(uart_t *uart);
 
 void uartSetRxInvert(uart_t *uart, bool invert);