Merge branch 'docs/update_pcnt_pm_lock_docs' into 'master'

docs(pcnt): update pcnt pm lock docs Closes IDFGH-14231 See merge request espressif/esp-idf!35756
espressif · Dec 24, 2024 · 4088e20 · 4088e20
2 parents ed02415 + 08a54bb
commit 4088e20
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 5 deletions.
diff --git a/components/esp_driver_pcnt/include/driver/pulse_cnt.h b/components/esp_driver_pcnt/include/driver/pulse_cnt.h
@@ -130,9 +130,6 @@ esp_err_t pcnt_del_unit(pcnt_unit_handle_t unit);
 /**
  * @brief Set glitch filter for PCNT unit
  *
- * @note The glitch filter module is clocked from APB, and APB frequency can be changed during DFS, which in return make the filter out of action.
- *       So this function will lazy-install a PM lock internally when the power management is enabled. With this lock, the APB frequency won't be changed.
- *       The PM lock can be uninstalled in `pcnt_del_unit()`.
  * @note This function should be called when the PCNT unit is in the init state (i.e. before calling `pcnt_unit_enable()`)
  *
  * @param[in] unit PCNT unit handle created by `pcnt_new_unit()`

diff --git a/docs/en/api-reference/system/power_management.rst b/docs/en/api-reference/system/power_management.rst
@@ -168,6 +168,7 @@ The following peripheral drivers are not aware of DFS yet. Applications need to
         .. list::
 
             :SOC_SDIO_SLAVE_SUPPORTED: - SDIO Slave
+            :SOC_PCNT_SUPPORTED: - PCNT
 
         The following peripherals (and those not listed in any group of this section) are not yet supported. If your application uses these peripherals, they may not work well after waking up from sleep.
 
@@ -176,7 +177,6 @@ The following peripheral drivers are not aware of DFS yet. Applications need to
             - ASSIST_DEBUG
             - Trace
             - Crypto: AES/ECC/HMAC/RSA/SHA/DS/XTA_AES/ECDSA
-            - PCNT
             - USB-Serial-JTAG
             - SARADC
 

diff --git a/docs/zh_CN/api-reference/system/power_management.rst b/docs/zh_CN/api-reference/system/power_management.rst
@@ -168,6 +168,7 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求，
         .. list::
 
             :SOC_SDIO_SLAVE_SUPPORTED: - SDIO Slave
+            :SOC_PCNT_SUPPORTED: - PCNT
 
         以下外设（以及一些未在本章节任意一组中列出的外设）尚未支持外设下电功能。如果您的应用使用了这些外设，它们可能无法在从睡眠中醒来后仍然正常工作：
 
@@ -176,7 +177,6 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求，
             - ASSIST_DEBUG
             - Trace
             - Crypto: AES/ECC/HMAC/RSA/SHA/DS/XTA_AES/ECDSA
-            - PCNT
             - USB-Serial-JTAG
             - SARADC