]> granicus.if.org Git - esp-idf/commitdiff
Corrected number of FSM cycles and related description
authorkrzychb <krzychb@gazeta.pl>
Mon, 10 Sep 2018 05:14:19 +0000 (07:14 +0200)
committerkrzychb <krzychb@gazeta.pl>
Mon, 10 Sep 2018 05:14:19 +0000 (07:14 +0200)
components/ulp/include/esp32/ulp.h

index e9668593d3ddadbe7c90ed7111e79463a1cdc53f..6960ac97d84a965530080ec6707bb08a952e9376 100644 (file)
@@ -900,13 +900,12 @@ esp_err_t ulp_run(uint32_t entry_point);
  *
  * @param period_index wakeup period setting number (0 - 4)
  * @param period_us wakeup period, us
- * @note  The ULP FSM requires some time to wakeup before being able to run the program.
- *        Then additional time is reserved after wakeup waiting until the 8M clock is stable.
- *        The FSM also requires time to go to sleep after the program execution is halted.
+ * @note  The ULP FSM requires two clock cycles to wakeup before being able to run the program.
+ *        Then additional 16 cycles are reserved after wakeup waiting until the 8M clock is stable.
+ *        The FSM also requires two more clock cycles to go to sleep after the program execution is halted.
  *        The minimum wakeup period that may be set up for the ULP
- *        is the total time spent on the above internal tasks.
- *        For a default configuration of the ULP running at 150kHz
- *        the minimum wakeup period is about 160us.
+ *        is equal to the total number of cycles spent on the above internal tasks.
+ *        For a default configuration of the ULP running at 150kHz it makes about 133us.
  * @return
  *      - ESP_OK on success
  *      - ESP_ERR_INVALID_ARG if period_index is out of range