forked from espressif/esp-idf
Merge branch 'docs/enable_adc_on_p4' into 'master'
docs(adc): update adc oneshot/continuous docs on P4 Closes IDF-7718 and IDF-7719 See merge request espressif/esp-idf!32815
This commit is contained in:
Gao Xu
@@ -6,8 +6,6 @@ api-guides/usb-otg-console.rst
|
|||||||
api-guides/esp-wifi-mesh.rst
|
api-guides/esp-wifi-mesh.rst
|
||||||
api-guides/dfu.rst
|
api-guides/dfu.rst
|
||||||
api-guides/wifi-security.rst
|
api-guides/wifi-security.rst
|
||||||
api-reference/peripherals/adc_continuous.rst
|
|
||||||
api-reference/peripherals/adc_oneshot.rst
|
|
||||||
api-reference/peripherals/touch_element.rst
|
api-reference/peripherals/touch_element.rst
|
||||||
api-reference/peripherals/touch_pad.rst
|
api-reference/peripherals/touch_pad.rst
|
||||||
api-reference/peripherals/adc_calibration.rst
|
api-reference/peripherals/adc_calibration.rst
|
||||||
|
|||||||
@@ -290,39 +290,19 @@ To do further calibration to convert the ADC raw result to voltage in mV, please
|
|||||||
Hardware Limitations
|
Hardware Limitations
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
- A specific ADC unit can only work under one operating mode at any one time, either continuous mode or one-shot mode. :cpp:func:`adc_continuous_start` has provided the protection.
|
.. list::
|
||||||
|
|
||||||
- Random Number Generator (RNG) uses ADC as an input source. When ADC continuous mode driver works, the random number generated from RNG will be less random.
|
- A specific ADC unit can only work under one operating mode at any one time, either continuous mode or one-shot mode. :cpp:func:`adc_continuous_start` has provided the protection.
|
||||||
|
- Random Number Generator (RNG) uses ADC as an input source. When ADC continuous mode driver works, the random number generated from RNG will be less random.
|
||||||
|
:esp32 or esp32s2: - ADC2 is also used by Wi-Fi. :cpp:func:`adc_continuous_start` has provided the protection between Wi-Fi driver and ADC continuous mode driver.
|
||||||
|
:esp32: - ADC continuous mode driver uses I2S0 peripheral as hardware DMA FIFO. Therefore, if I2S0 is in use already, the :cpp:func:`adc_continuous_new_handle` will return :c:macro:`ESP_ERR_NOT_FOUND`.
|
||||||
|
:esp32: - ESP32 DevKitC: GPIO 0 cannot be used due to external auto program circuits.
|
||||||
|
:esp32: - ESP-WROVER-KIT: GPIO 0, 2, 4, and 15 cannot be used due to external connections for different purposes.
|
||||||
|
:esp32s2: - ADC continuous mode driver uses SPI3 peripheral as hardware DMA FIFO. Therefore, if SPI3 is in use already, the :cpp:func:`adc_continuous_new_handle` will return :c:macro:`ESP_ERR_NOT_FOUND`.
|
||||||
|
:esp32c3: - ADC2 DMA functionality is no longer supported to retrieve ADC conversion results due to hardware limitations, as unstable results have been observed. This issue can be found in `ESP32C3 Errata <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3` to force use ADC2.
|
||||||
|
:esp32s3: - ADC2 DMA functionality is no longer supported to retrieve ADC conversion results due to hardware limitations, as unstable results have been observed. This issue can be found in `ESP32S3 Errata <https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3` to force use ADC2.
|
||||||
|
|
||||||
.. only:: esp32 or esp32s2
|
.. _adc-continuous-power-management:
|
||||||
|
|
||||||
- ADC2 is also used by Wi-Fi. :cpp:func:`adc_continuous_start` has provided the protection between Wi-Fi driver and ADC continuous mode driver.
|
|
||||||
|
|
||||||
.. only:: esp32
|
|
||||||
|
|
||||||
- ADC continuous mode driver uses I2S0 peripheral as hardware DMA FIFO. Therefore, if I2S0 is in use already, the :cpp:func:`adc_continuous_new_handle` will return :c:macro:`ESP_ERR_NOT_FOUND`.
|
|
||||||
|
|
||||||
- ESP32 DevKitC: GPIO 0 cannot be used due to external auto program circuits.
|
|
||||||
|
|
||||||
- ESP-WROVER-KIT: GPIO 0, 2, 4, and 15 cannot be used due to external connections for different purposes.
|
|
||||||
|
|
||||||
.. only:: esp32s2
|
|
||||||
|
|
||||||
- ADC continuous mode driver uses SPI3 peripheral as hardware DMA FIFO. Therefore, if SPI3 is in use already, the :cpp:func:`adc_continuous_new_handle` will return :c:macro:`ESP_ERR_NOT_FOUND`.
|
|
||||||
|
|
||||||
.. only:: esp32c3
|
|
||||||
|
|
||||||
- ADC2 DMA functionality is no longer supported to retrieve ADC conversion results due to hardware limitations, as unstable results have been observed. This issue can be found in `ESP32C3 Errata <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3` to force use ADC2.
|
|
||||||
|
|
||||||
.. only:: esp32s3
|
|
||||||
|
|
||||||
- ADC2 DMA functionality is no longer supported to retrieve ADC conversion results due to hardware limitations, as unstable results have been observed. This issue can be found in `ESP32S3 Errata <https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3` to force use ADC2.
|
|
||||||
|
|
||||||
.. _adc-continuous-power-management:
|
|
||||||
|
|
||||||
.. only:: not esp32s3
|
|
||||||
|
|
||||||
.. _adc-continuous-power-management:
|
|
||||||
|
|
||||||
Power Management
|
Power Management
|
||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -3,20 +3,17 @@ Analog to Digital Converter (ADC) Oneshot Mode Driver
|
|||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
|
|
||||||
{IDF_TARGET_ADC_NUM:default="two", esp32c2="one", esp32c6="one", esp32h2="one", esp32c5="one"}
|
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pins.
|
The Analog to Digital Converter is integrated on the chip and is capable of measuring analog signals from specific analog IO pins.
|
||||||
|
|
||||||
{IDF_TARGET_NAME} has {IDF_TARGET_ADC_NUM} ADC unit(s), which can be used in scenario(s) like:
|
{IDF_TARGET_NAME} has {SOC_ADC_PERIPH_NUM} ADC unit(s), which can be used in scenario(s) like:
|
||||||
|
|
||||||
- Generate one-shot ADC conversion result
|
.. list::
|
||||||
|
|
||||||
.. only:: SOC_ADC_DMA_SUPPORTED
|
- Generate one-shot ADC conversion result
|
||||||
|
:SOC_ADC_DMA_SUPPORTED: - Generate continuous ADC conversion results
|
||||||
- Generate continuous ADC conversion results
|
|
||||||
|
|
||||||
This guide introduces ADC oneshot mode conversion.
|
This guide introduces ADC oneshot mode conversion.
|
||||||
|
|
||||||
@@ -164,31 +161,16 @@ Read Raw Result
|
|||||||
Hardware Limitations
|
Hardware Limitations
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
- Random Number Generator (RNG) uses ADC as an input source. When ADC :cpp:func:`adc_oneshot_read` works, the random number generated from RNG will be less random.
|
.. list::
|
||||||
|
|
||||||
.. only:: SOC_ADC_DMA_SUPPORTED
|
- Random Number Generator (RNG) uses ADC as an input source. When ADC :cpp:func:`adc_oneshot_read` works, the random number generated from RNG will be less random.
|
||||||
|
:SOC_ADC_DMA_SUPPORTED: - A specific ADC unit can only work under one operating mode at any one time, either continuous mode or oneshot mode. :cpp:func:`adc_oneshot_read` has provided the protection.
|
||||||
|
:esp32 or esp32s2 or esp32s3: - ADC2 is also used by Wi-Fi. :cpp:func:`adc_oneshot_read` has provided protection between the Wi-Fi driver and ADC oneshot mode driver.
|
||||||
|
:esp32c3: - ADC2 oneshot mode is no longer supported, due to hardware limitations. The results are not stable. This issue can be found in `ESP32-C3 Series SoC Errata <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_ONESHOT_FORCE_USE_ADC2_ON_C3` to force use ADC2.
|
||||||
|
:esp32: - ESP32-DevKitC: GPIO0 cannot be used in oneshot mode, because the DevKit has used it for auto-flash.
|
||||||
|
:esp32: - ESP-WROVER-KIT: GPIO 0, 2, 4, and 15 cannot be used due to external connections for different purposes.
|
||||||
|
|
||||||
- A specific ADC unit can only work under one operating mode at any one time, either continuous mode or oneshot mode. :cpp:func:`adc_oneshot_read` has provided the protection.
|
.. _adc-oneshot-power-management:
|
||||||
|
|
||||||
.. only:: esp32 or esp32s2 or esp32s3
|
|
||||||
|
|
||||||
- ADC2 is also used by Wi-Fi. :cpp:func:`adc_oneshot_read` has provided protection between the Wi-Fi driver and ADC oneshot mode driver.
|
|
||||||
|
|
||||||
.. only:: esp32c3
|
|
||||||
|
|
||||||
- ADC2 oneshot mode is no longer supported, due to hardware limitations. The results are not stable. This issue can be found in `ESP32-C3 Series SoC Errata <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_en.pdf>`_. For compatibility, you can enable :ref:`CONFIG_ADC_ONESHOT_FORCE_USE_ADC2_ON_C3` to force use ADC2.
|
|
||||||
|
|
||||||
.. only:: esp32
|
|
||||||
|
|
||||||
- ESP32-DevKitC: GPIO0 cannot be used in oneshot mode, because the DevKit has used it for auto-flash.
|
|
||||||
|
|
||||||
- ESP-WROVER-KIT: GPIO 0, 2, 4, and 15 cannot be used due to external connections for different purposes.
|
|
||||||
|
|
||||||
.. _adc-oneshot-power-management:
|
|
||||||
|
|
||||||
.. only:: not esp32
|
|
||||||
|
|
||||||
.. _adc-oneshot-power-management:
|
|
||||||
|
|
||||||
Power Management
|
Power Management
|
||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -290,39 +290,19 @@ ADC 连续转换模式驱动使用内部缓冲池保存转换结果，缓冲池
|
|||||||
硬件限制
|
硬件限制
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
- 一个 ADC 单元一次只能运行一种操作模式，即连续模式或单次模式。:cpp:func:`adc_continuous_start` 提供了保护措施。
|
.. list::
|
||||||
|
|
||||||
- 随机数生成器 (RNG) 以 ADC 为输入源。使用 ADC 连续转换模式驱动从 RNG 生成随机数时，随机性会减弱。
|
- 一个 ADC 单元一次只能运行一种操作模式，即连续模式或单次模式。:cpp:func:`adc_continuous_start` 提供了保护措施。
|
||||||
|
- 随机数生成器 (RNG) 以 ADC 为输入源。使用 ADC 连续转换模式驱动从 RNG 生成随机数时，随机性会减弱。
|
||||||
|
:esp32 or esp32s2: - Wi-Fi 也使用 ADC2，:cpp:func:`adc_continuous_start` 提供了 Wi-Fi 驱动和 ADC 连续转换模式驱动之间的保护。
|
||||||
|
:esp32: - ADC 连续转换模式驱动使用 I2S0 外设作为硬件 DMA FIFO。因此，如果 I2S0 已在使用中，:cpp:func:`adc_continuous_new_handle` 将返回 :c:macro:`ESP_ERR_NOT_FOUND`。
|
||||||
|
:esp32: - ESP32 DevKitC：由于存在外部自动烧录电路，GPIO 0 不能用于 ADC 连续转换模式。
|
||||||
|
:esp32: - ESP-WROVER-KIT：由于部分 GPIO 管脚可能已经用于其他目的，GPIO 0、2、4 和 15 不能用于 ADC 连续转换模式。
|
||||||
|
:esp32s2: - ADC 连续转换模式驱动使用 SPI3 外设作为硬件 DMA FIFO。因此，如果 SPI3 已在使用中，:cpp:func:`adc_continuous_new_handle` 将返回 :c:macro:`ESP_ERR_NOT_FOUND`。
|
||||||
|
:esp32c3: - 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 连续转换的结果可能不稳定，具体可参考 `ESP32-C3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3`，强制使用 ADC2。
|
||||||
|
:esp32s3: - 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 连续转换的结果可能不稳定，具体可参考 `ESP32-S3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3`，强制使用 ADC2。
|
||||||
|
|
||||||
.. only:: esp32 or esp32s2
|
.. _adc-continuous-power-management:
|
||||||
|
|
||||||
- Wi-Fi 也使用 ADC2，:cpp:func:`adc_continuous_start` 提供了 Wi-Fi 驱动和 ADC 连续转换模式驱动之间的保护。
|
|
||||||
|
|
||||||
.. only:: esp32
|
|
||||||
|
|
||||||
- ADC 连续转换模式驱动使用 I2S0 外设作为硬件 DMA FIFO。因此，如果 I2S0 已在使用中，:cpp:func:`adc_continuous_new_handle` 将返回 :c:macro:`ESP_ERR_NOT_FOUND`。
|
|
||||||
|
|
||||||
- ESP32 DevKitC：由于存在外部自动烧录电路，GPIO 0 不能用于 ADC 连续转换模式。
|
|
||||||
|
|
||||||
- ESP-WROVER-KIT：由于部分 GPIO 管脚可能已经用于其他目的，GPIO 0、2、4 和 15 不能用于 ADC 连续转换模式。
|
|
||||||
|
|
||||||
.. only:: esp32s2
|
|
||||||
|
|
||||||
- ADC 连续转换模式驱动使用 SPI3 外设作为硬件 DMA FIFO。因此，如果 SPI3 已在使用中，:cpp:func:`adc_continuous_new_handle` 将返回 :c:macro:`ESP_ERR_NOT_FOUND`。
|
|
||||||
|
|
||||||
.. only:: esp32c3
|
|
||||||
|
|
||||||
- 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 连续转换的结果可能不稳定，具体可参考 `ESP32-C3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3`，强制使用 ADC2。
|
|
||||||
|
|
||||||
.. only:: esp32s3
|
|
||||||
|
|
||||||
- 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 连续转换的结果可能不稳定，具体可参考 `ESP32-S3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3`，强制使用 ADC2。
|
|
||||||
|
|
||||||
.. _adc-continuous-power-management:
|
|
||||||
|
|
||||||
.. only:: not esp32s3
|
|
||||||
|
|
||||||
.. _adc-continuous-power-management:
|
|
||||||
|
|
||||||
电源管理
|
电源管理
|
||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -3,20 +3,17 @@
|
|||||||
|
|
||||||
:link_to_translation:`en:[English]`
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
{IDF_TARGET_ADC_NUM:default="两", esp32c2="一", esp32c6="一", esp32h2="一", esp32c5="一"}
|
|
||||||
|
|
||||||
简介
|
简介
|
||||||
----
|
----
|
||||||
|
|
||||||
模数转换器集成于芯片，支持测量特定模拟 IO 管脚的模拟信号。
|
模数转换器集成于芯片，支持测量特定模拟 IO 管脚的模拟信号。
|
||||||
|
|
||||||
{IDF_TARGET_NAME} 有 {IDF_TARGET_ADC_NUM} 个 ADC 单元，可以在以下场景使用：
|
{IDF_TARGET_NAME} 有 {SOC_ADC_PERIPH_NUM} 个 ADC 单元，可以在以下场景使用：
|
||||||
|
|
||||||
- 生成 ADC 单次转换结果
|
.. list::
|
||||||
|
|
||||||
.. only:: SOC_ADC_DMA_SUPPORTED
|
- 生成 ADC 单次转换结果
|
||||||
|
:SOC_ADC_DMA_SUPPORTED: - 生成连续 ADC 转换结果
|
||||||
- 生成连续 ADC 转换结果
|
|
||||||
|
|
||||||
本指南介绍了 ADC 单次转换模式。
|
本指南介绍了 ADC 单次转换模式。
|
||||||
|
|
||||||
@@ -164,31 +161,16 @@ ADC 单次转换模式驱动基于 {IDF_TARGET_NAME} SAR ADC 模块实现，不
|
|||||||
硬件限制
|
硬件限制
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
- 随机数生成器 (RNG) 以 ADC 为输入源。使用 ADC 单次转换模式驱动从 RNG 生成随机数时，随机性会减弱。
|
.. list::
|
||||||
|
|
||||||
.. only:: SOC_ADC_DMA_SUPPORTED
|
- 随机数生成器 (RNG) 以 ADC 为输入源。使用 ADC 单次转换模式驱动从 RNG 生成随机数时，随机性会减弱。
|
||||||
|
:SOC_ADC_DMA_SUPPORTED: - 一个 ADC 单元每次只能在一种操作模式下运行，可以是连续模式或单次模式。:cpp:func:`adc_oneshot_start` 提供了保护措施。
|
||||||
|
:esp32 or esp32s2 or esp32s3: - Wi-Fi 也使用 ADC2，:cpp:func:`adc_oneshot_read` 提供了 Wi-Fi 驱动与 ADC 单次转换模式驱动间的保护。
|
||||||
|
:esp32c3: - 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 单次转换的结果可能不稳定，具体可参考 `ESP32-C3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_ONESHOT_FORCE_USE_ADC2_ON_C3`，强制使用 ADC2。
|
||||||
|
:esp32: - ESP32-DevKitC：GPIO0 已用于自动烧录功能，不能用于 ADC 单次转换模式。
|
||||||
|
:esp32: - ESP-WROVER-KIT：GPIO0、GPIO2、GPIO4 和 GPIO15 已有其他用途，不能用于 ADC 单次转换模式。
|
||||||
|
|
||||||
- 一个 ADC 单元每次只能在一种操作模式下运行，可以是连续模式或单次模式。:cpp:func:`adc_oneshot_start` 提供了保护措施。
|
.. _adc-oneshot-power-management:
|
||||||
|
|
||||||
.. only:: esp32 or esp32s2 or esp32s3
|
|
||||||
|
|
||||||
- Wi-Fi 也使用 ADC2，:cpp:func:`adc_oneshot_read` 提供了 Wi-Fi 驱动与 ADC 单次转换模式驱动间的保护。
|
|
||||||
|
|
||||||
.. only:: esp32c3
|
|
||||||
|
|
||||||
- 由于硬件限制，现已不再支持使用 ADC2 DMA 功能获取 ADC 转换结果。使用 ADC2 单次转换的结果可能不稳定，具体可参考 `ESP32-C3 系列芯片勘误表 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_cn.pdf>`__。出于兼容性考虑，可以启用 :ref:`CONFIG_ADC_ONESHOT_FORCE_USE_ADC2_ON_C3`，强制使用 ADC2。
|
|
||||||
|
|
||||||
.. only:: esp32
|
|
||||||
|
|
||||||
- ESP32-DevKitC：GPIO0 已用于自动烧录功能，不能用于 ADC 单次转换模式。
|
|
||||||
|
|
||||||
- ESP-WROVER-KIT：GPIO0、GPIO2、GPIO4 和 GPIO15 已有其他用途，不能用于 ADC 单次转换模式。
|
|
||||||
|
|
||||||
.. _adc-oneshot-power-management:
|
|
||||||
|
|
||||||
.. only:: not esp32
|
|
||||||
|
|
||||||
.. _adc-oneshot-power-management:
|
|
||||||
|
|
||||||
电源管理
|
电源管理
|
||||||
^^^^^^^^
|
^^^^^^^^
|
||||||
|
|||||||
Reference in New Issue
Block a user