Merge branch 'docs/ulp_lp_uart' into 'master'

docs(ulp): add info about lp-uart to lp-core docs

See merge request espressif/esp-idf!26405

components/ulp/lp_core/lp_core/include/ulp_lp_core_uart.h

@@ -50,7 +50,7 @@ esp_err_t lp_core_uart_write_bytes(uart_port_t lp_uart_num, const void *src, siz
  * This function will read data from the Rx FIFO. If a timeout value is configured, then this function will timeout once the number of CPU cycles expire.
  *
  * @param lp_uart_num   LP UART port number
- * @param src           data buffer address
+ * @param buf           data buffer address
  * @param size          data length to send
  * @param timeout       Operation timeout in CPU cycles. Set to -1 to wait forever.
  *

docs/component_info_ignore_file.txt

@@ -3,6 +3,8 @@
 # ULP header files for the ULP app do not have an IDF header path/component require
 components/ulp/lp_core/lp_core/include/ulp_lp_core_gpio.h
 components/ulp/lp_core/lp_core/include/ulp_lp_core_i2c.h
+components/ulp/lp_core/lp_core/include/ulp_lp_core_print.h
+components/ulp/lp_core/lp_core/include/ulp_lp_core_uart.h
 components/ulp/lp_core/lp_core/include/ulp_lp_core_utils.h
 # ESSL headers do not belong to any IDF component, in a user project it will come from a managed component
 components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_sdio.h

docs/doxygen/Doxyfile_esp32c6

@@ -1,8 +1,11 @@
 INPUT += \
     $(PROJECT_PATH)/components/ulp/lp_core/include/lp_core_i2c.h \
+    $(PROJECT_PATH)/components/ulp/lp_core/include/lp_core_uart.h \
     $(PROJECT_PATH)/components/ulp/lp_core/include/ulp_lp_core.h \
     $(PROJECT_PATH)/components/ulp/lp_core/lp_core/include/ulp_lp_core_gpio.h \
     $(PROJECT_PATH)/components/ulp/lp_core/lp_core/include/ulp_lp_core_i2c.h \
+    $(PROJECT_PATH)/components/ulp/lp_core/lp_core/include/ulp_lp_core_print.h \
+    $(PROJECT_PATH)/components/ulp/lp_core/lp_core/include/ulp_lp_core_uart.h \
     $(PROJECT_PATH)/components/ulp/lp_core/lp_core/include/ulp_lp_core_utils.h \
     $(PROJECT_PATH)/components/bt/include/esp32c6/include/esp_bt.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \

docs/en/api-reference/system/ulp-lp-core.rst

@@ -153,12 +153,15 @@ To enhance the capabilities of the ULP LP-Core coprocessor, it has access to per
 
  * LP IO
  * LP I2C
+ * LP UART
 
 Application Examples
 --------------------
 
-* ULP LP-Core Coprocessor polls GPIO while main CPU is in deep sleep: :example:`system/ulp/lp_core/gpio`.
-* ULP LP-Core Coprocessor reads external I2C ambient light sensor (BH1750) while the main CPU is in Deep-sleep and wakes up the main CPU once a threshold is met: :example:`system/ulp/lp_core/lp_i2c`.
+* :example:`system/ulp/lp_core/gpio` polls GPIO while main CPU is in deep sleep.
+* :example:`system/ulp/lp_core/lp_i2c` reads external I2C ambient light sensor (BH1750) while the main CPU is in Deep-sleep and wakes up the main CPU once a threshold is met.
+* :example:`system/ulp/lp_core/lp_uart/lp_uart_echo` reads data written to a serial console and echoes it back. This example demonstrates the usage of the LP UART driver from the LP core.
+* :example:`system/ulp/lp_core/lp_uart/lp_uart_print` shows how to print various statements from a program running on the LP core.
 
 API Reference
 -------------
@@ -168,10 +171,13 @@ Main CPU API Reference
 
 .. include-build-file:: inc/ulp_lp_core.inc
 .. include-build-file:: inc/lp_core_i2c.inc
+.. include-build-file:: inc/lp_core_uart.inc
 
 LP Core API Reference
 ~~~~~~~~~~~~~~~~~~~~~~
 
 .. include-build-file:: inc/ulp_lp_core_utils.inc
 .. include-build-file:: inc/ulp_lp_core_gpio.inc
 .. include-build-file:: inc/ulp_lp_core_i2c.inc
+.. include-build-file:: inc/ulp_lp_core_uart.inc
+.. include-build-file:: inc/ulp_lp_core_print.inc