Skip to content

Commit 3264693

Browse files
authored
feat(uart): documents UART_CLK_SRC_DEFAULT as option in header file
1 parent 0fe2b60 commit 3264693

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

cores/esp32/HardwareSerial.h

+1
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,7 @@ class HardwareSerial : public Stream {
371371
bool setMode(SerialMode mode);
372372
// Used to set the UART clock source mode. It must be set before calling begin(), otherwise it won't have any effect.
373373
// Not all clock source are available to every SoC. The compatible option are listed here:
374+
// UART_CLK_SRC_DEFAULT :: any SoC - it will set whatever IDF defines as the default UART Clock Source
374375
// UART_CLK_SRC_APB :: ESP32, ESP32-S2, ESP32-C3 and ESP32-S3
375376
// UART_CLK_SRC_PLL :: ESP32-C2, ESP32-C5, ESP32-C6, ESP32-C61, ESP32-H2 and ESP32-P4
376377
// UART_CLK_SRC_XTAL :: ESP32-C2, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-C61, ESP32-H2, ESP32-S3 and ESP32-P4

0 commit comments

Comments
 (0)