alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-23 09:20:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feat/sdm_sleep_retention' into 'master'

Browse Source 
sdm driver sleep retention support and thread safety enhancement

Closes IDF-12348, IDF-13686, IDF-10700, IDF-9742, IDF-9771, and IDF-10396

See merge request espressif/esp-idf!41088
This commit is contained in:
morris
2025-08-11 18:23:50 +08:00
parent 3ef41363cf 0eb611a797
commit ae221cb24f
85 changed files with 1023 additions and 606 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/api-reference/peripherals/sdm.rst
View File

@@ -102,13 +102,13 @@ There is a Kconfig option :ref:`CONFIG_SDM_CTRL_FUNC_IN_IRAM` that can put commo
Thread Safety
^^^^^^^^^^^^^
The factory function :cpp:func:`sdm_new_channel` is guaranteed to be thread-safe by the driver, which means, the user can call it from different RTOS tasks without protection by extra locks.
The driver uses critical sections to ensure atomic operations on registers. Key members in the driver handle are also protected by critical sections. The driver's internal state machine uses atomic instructions to ensure thread safety, with state checks preventing certain invalid concurrent operations (e.g., conflicts between `enable` and `delete`). Therefore, SDM driver APIs can be used in a multi-threaded environment without extra locking.
The following functions are allowed to run under ISR context, the driver uses a critical section to prevent them being called concurrently in both task and ISR.
The following functions can also be used in an interrupt context:
- :cpp:func:`sdm_channel_set_pulse_density`
.. list::
Other functions that take the :cpp:type:`sdm_channel_handle_t` as the first positional parameter, are not treated as thread-safe. This means the user should avoid calling them from multiple tasks.
- :cpp:func:`sdm_channel_set_pulse_density`
.. _sdm-kconfig-options: