ulp: add note regarding limitation of ulp_set_wakeup_period in deep sleep mode

diff --git a/components/ulp/include/esp32/ulp.h b/components/ulp/include/esp32/ulp.h
index 6960ac97d84a965530080ec6707bb08a952e9376..c9ca51101797bc202b6efb749f45ed8a2aafb329 100644 (file)
--- a/components/ulp/include/esp32/ulp.h
+++ b/components/ulp/include/esp32/ulp.h
@@ -898,6 +898,9 @@ esp_err_t ulp_run(uint32_t entry_point);
  * i.e. period number 0. ULP program code can use SLEEP instruction to select
  * which of the SENS_ULP_CP_SLEEP_CYCx_REG should be used for subsequent wakeups.
  *
+ * However, please note that SLEEP instruction issued (from ULP program) while the system
+ * is in deep sleep mode does not have effect, and sleep cycle count 0 is used.
+ *
  * @param period_index wakeup period setting number (0 - 4)
  * @param period_us wakeup period, us
  * @note  The ULP FSM requires two clock cycles to wakeup before being able to run the program.

diff --git a/docs/en/api-guides/ulp-cmake.rst b/docs/en/api-guides/ulp-cmake.rst
index 6a63f11b4623a8a6f538a777bb474fb2f38e36b2..87ed13aa0a527c255232473c9c48dbcc5067595c 100644 (file)
--- a/docs/en/api-guides/ulp-cmake.rst
+++ b/docs/en/api-guides/ulp-cmake.rst
@@ -152,7 +152,7 @@ ULP program flow
 
 ULP coprocessor is started by a timer. The timer is started once ``ulp_run`` is called. The timer counts a number of RTC_SLOW_CLK ticks (by default, produced by an internal 150kHz RC oscillator). The number of ticks is set using ``SENS_ULP_CP_SLEEP_CYCx_REG`` registers (x = 0..4). When starting the ULP for the first time, ``SENS_ULP_CP_SLEEP_CYC0_REG`` will be used to set the number of timer ticks. Later the ULP program can select another ``SENS_ULP_CP_SLEEP_CYCx_REG`` register using ``sleep`` instruction.
 
-The application can set ULP timer period values (SENS_ULP_CP_SLEEP_CYCx_REG, x = 0..4) using ``ulp_wakeup_period_set`` function.
+The application can set ULP timer period values (SENS_ULP_CP_SLEEP_CYCx_REG, x = 0..4) using ``ulp_set_wakeup_period`` function.
 
 .. doxygenfunction:: ulp_set_wakeup_period
 

diff --git a/docs/en/api-guides/ulp.rst b/docs/en/api-guides/ulp.rst
index a712b8ec023c2fca6eb231c4a033b1aa2fc93be2..e59c3cc7513bf563a20bce47d59a67acfb448b3e 100644 (file)
--- a/docs/en/api-guides/ulp.rst
+++ b/docs/en/api-guides/ulp.rst
@@ -151,7 +151,7 @@ ULP program flow
 
 ULP coprocessor is started by a timer. The timer is started once ``ulp_run`` is called. The timer counts a number of RTC_SLOW_CLK ticks (by default, produced by an internal 150kHz RC oscillator). The number of ticks is set using ``SENS_ULP_CP_SLEEP_CYCx_REG`` registers (x = 0..4). When starting the ULP for the first time, ``SENS_ULP_CP_SLEEP_CYC0_REG`` will be used to set the number of timer ticks. Later the ULP program can select another ``SENS_ULP_CP_SLEEP_CYCx_REG`` register using ``sleep`` instruction.
 
-The application can set ULP timer period values (SENS_ULP_CP_SLEEP_CYCx_REG, x = 0..4) using ``ulp_wakeup_period_set`` function.
+The application can set ULP timer period values (SENS_ULP_CP_SLEEP_CYCx_REG, x = 0..4) using ``ulp_set_wakeup_period`` function.
 
 .. doxygenfunction:: ulp_set_wakeup_period