docs(rmt): add a note about binding channels to the same GPIO

Added a note about RX Channel and TX Channel initialization order when bound RX and TX to the same gpio. Closes #11768
espressif · Jul 3, 2023 · 3f0b46d · 3f0b46d
1 parent 91f16fe
commit 3f0b46d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/en/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst
@@ -141,6 +141,10 @@ Once the :cpp:type:`rmt_rx_channel_config_t` structure is populated with mandato
  };
  ESP_ERROR_CHECK(rmt_new_rx_channel(&rx_chan_config, &rx_chan));
 
+.. note::
+
+ Due to a software limitation in the GPIO driver, when both TX and RX channels are bound to the same GPIO, ensure the RX Channel is initialized before the TX Channel. If the TX Channel was set up first, then during the RX Channel setup, the previous RMT TX Channel signal will be overridden by the GPIO control signal.
+
 Uninstall RMT Channel
 ~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/zh_CN/api-reference/peripherals/rmt.rst b/docs/zh_CN/api-reference/peripherals/rmt.rst
@@ -141,6 +141,10 @@ RMT 接收器可以对输入信号采样，将其转换为 RMT 数据格式，
  };
  ESP_ERROR_CHECK(rmt_new_rx_channel(&rx_chan_config, &rx_chan));
 
+.. note::
+
+ 由于 GPIO 驱动程序中的软件限制，当 TX 和 RX 通道都绑定到同一 GPIO 时，请确保在 TX 通道之前初始化 RX 通道。如果先设置 TX 通道，那么在 RX 通道设置期间，GPIO 控制信号将覆盖先前的 RMT TX 通道信号。
+
 卸载 RMT 通道
 ~~~~~~~~~~~~~~~~~~~~~