Corrected number of FSM cycles and related description

This commit is contained in:
krzychb
2018-09-10 07:14:19 +02:00
parent 5eee2bf37d
commit f6b0b27026

View 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_index wakeup period setting number (0 - 4)
* @param period_us wakeup period, us * @param period_us wakeup period, us
* @note The ULP FSM requires some time to wakeup before being able to run the program. * @note The ULP FSM requires two clock cycles to wakeup before being able to run the program.
* Then additional time is reserved after wakeup waiting until the 8M clock is stable. * Then additional 16 cycles are 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. * 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 * The minimum wakeup period that may be set up for the ULP
* is the total time spent on the above internal tasks. * is equal to the total number of cycles spent on the above internal tasks.
* For a default configuration of the ULP running at 150kHz * For a default configuration of the ULP running at 150kHz it makes about 133us.
* the minimum wakeup period is about 160us.
* @return * @return
* - ESP_OK on success * - ESP_OK on success
* - ESP_ERR_INVALID_ARG if period_index is out of range * - ESP_ERR_INVALID_ARG if period_index is out of range