From da9972183cfdc15576c94e1176b912f6fbe2b2d6 Mon Sep 17 00:00:00 2001 From: zwx Date: Wed, 15 Nov 2023 12:00:13 +0800 Subject: [PATCH] feat(docs): Add RF Coexist docs for H2 --- docs/docs_not_updated/esp32h2.txt | 2 -- docs/en/api-guides/coexist.rst | 28 ++++++++++++++++++++++++---- docs/zh_CN/api-guides/coexist.rst | 28 +++++++++++++++++++++++++--- 3 files changed, 49 insertions(+), 9 deletions(-) delete mode 100644 docs/docs_not_updated/esp32h2.txt diff --git a/docs/docs_not_updated/esp32h2.txt b/docs/docs_not_updated/esp32h2.txt deleted file mode 100644 index f97c7f5887..0000000000 --- a/docs/docs_not_updated/esp32h2.txt +++ /dev/null @@ -1,2 +0,0 @@ -api-guides/RF_calibration -api-guides/coexist diff --git a/docs/en/api-guides/coexist.rst b/docs/en/api-guides/coexist.rst index 328af6b762..d0a626097a 100644 --- a/docs/en/api-guides/coexist.rst +++ b/docs/en/api-guides/coexist.rst @@ -6,7 +6,7 @@ RF Coexistence Overview --------------- -{IDF_TARGET_NAME} has only one 2.4 GHz ISM band RF module, which is shared by Bluetooth (BT & BLE) and Wi-Fi, so Bluetooth can't receive or transmit data while Wi-Fi is receiving or transmitting data and vice versa. Under such circumstances, {IDF_TARGET_NAME} uses the time-division multiplexing method to receive and transmit packets. +ESP boards now support three modules: Bluetooth (BT & BLE), IEEE802.15.4, and Wi-Fi. Each type of board has only one 2.4 GHz ISM band RF module, shared by two or three modules. Consequently, a module cannot receive or transmit data while another module is engaged in data transmission or reception. In such scenarios, {IDF_TARGET_NAME} employs the time-division multiplexing method to manage the reception and transmission of packets. Supported Coexistence Scenario for {IDF_TARGET_NAME} @@ -69,6 +69,24 @@ Supported Coexistence Scenario for {IDF_TARGET_NAME} | | |TX |Y |Y |Y |Y |Y | +-------+--------+-----------+--------+-------------+-----+----------+-----------+ +.. only:: SOC_IEEE802154_SUPPORTED + + .. table:: Supported Features of Thread (IEEE802.15.4) and BLE Coexistence + + +--------+-----------------+-----+------------+-----------+----------+ + | |BLE | + + +-----+------------+-----------+----------+ + | |Scan |Advertising |Connecting |Connected | + +--------+-----------------+-----+------------+-----------+----------+ + | Thread |Scan |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connecting |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connected |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connected | | | | | + | |(high throughput)|X |C1 |C1 |C1 | + +--------+-----------------+-----+------------+-----------+----------+ .. note:: @@ -131,6 +149,9 @@ Coexistence Period and Time Slice Wi-Fi and BLE have their fixed time slice to use the RF. In the Wi-Fi time slice, Wi-Fi will send a higher priority request to the coexistence arbitration module. Similarly, BLE can enjoy higher priority at their own time slice. The duration of the coexistence period and the proportion of each time slice are divided into four categories according to the Wi-Fi status: +.. only:: SOC_IEEE802154_SUPPORTED + + Currently, the only supported strategy ensures that the priority of BLE always takes precedence over IEEE802.15.4. .. list:: @@ -154,8 +175,7 @@ According to the coexistence logic, different coexistence periods and time slice Dynamic Priority """""""""""""""""""""""""""" -The coexistence module assigns different priorities to different status of Wi-Fi and Bluetooth. And the priority for each status is dynamic. For example, in every N BLE Advertising events, there is always one event with high priority. If a high-priority BLE Advertising event occurs within the Wi-Fi time slice, the right to use the RF may be preempted by BLE. - +The coexistence module assigns varying priorities to different statuses of each module, and these priorities are dynamic. For example, in every N BLE Advertising events, there is always one event with high priority. If a high-priority BLE Advertising event occurs within the Wi-Fi time slice, the right to use the RF may be preempted by BLE. .. only:: SOC_WIFI_SUPPORTED @@ -231,4 +251,4 @@ Setting Coexistence Compile-time Options .. note:: - Since the coexistence configuration option depends on the Bluetooth configuration option, please turn on the Bluetooth configuration option first before configuring the coexistence feature in the Wi-Fi configuration option. + As the coexistence configuration option relies on the presence of any two enabled modules, please ensure that both modules are activated before configuring any coexistence features. diff --git a/docs/zh_CN/api-guides/coexist.rst b/docs/zh_CN/api-guides/coexist.rst index e22af959b7..5680a483cf 100644 --- a/docs/zh_CN/api-guides/coexist.rst +++ b/docs/zh_CN/api-guides/coexist.rst @@ -6,7 +6,7 @@ RF 共存 概览 ----- -{IDF_TARGET_NAME} 只支持一路 RF，Bluetooth（BT 和 BLE）和 Wi-Fi 共享这一路 RF，无法同时收发数据，因此采用时分复用的方法进行收发数据包。 +ESP系列芯片最多支持三种射频收发模块: Bluetooth（BT 和 BLE）, IEEE802.15.4 和 Wi-Fi, 而每款芯片只支持一路被多个射频收发模块共享的 RF，不同模块无法同时使用 RF 收发数据，因此采用时分复用的方法调节不同模块的数据包收发。 {IDF_TARGET_NAME} 支持的共存场景 @@ -69,6 +69,25 @@ RF 共存 | | |TX |Y |Y |Y |Y |Y | +-------+--------+-----------+--------+-------------+-----+----------+-----------+ +.. only:: SOC_IEEE802154_SUPPORTED + + .. table:: 表 3 Thread (IEEE802.15.4) 和 BLE 共存支持功能 + + + +--------+-----------------+-----+------------+-----------+----------+ + | |BLE | + + +-----+------------+-----------+----------+ + | |Scan |Advertising |Connecting |Connected | + +--------+-----------------+-----+------------+-----------+----------+ + | Thread |Scan |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connecting |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connected |X |Y |Y |Y | + + +-----------------+-----+------------+-----------+----------+ + | |Connected | | | | | + | |(high throughput)|X |C1 |C1 |C1 | + +--------+-----------------+-----+------------+-----------+----------+ .. note:: @@ -131,6 +150,9 @@ RF 共存 Wi-Fi、BLE 二者对于 RF 的使用，主要是按照时间片来划分的。在 Wi-Fi 的时间片内，Wi-Fi 会向共存仲裁模块发出较高优先级的请求，在 Bluetooth 的时间片内，BLE 会具有较高优先级。共存周期大小和各个时间片占比根据 Wi-Fi 的状态分成四类： +.. only:: SOC_IEEE802154_SUPPORTED + + 目前, 当 BLE 与 IEEE802.15.4 共存时, ESP 芯片使用的策略为 BLE 优先级始终优先于 IEEE802.15.4。 .. list:: @@ -154,7 +176,7 @@ RF 共存 动态优先级 """"""""""""""""""" -共存模块对 Wi-Fi 和 Bluetooth 不同的状态赋予其不同的优先级。每种状态下的优先级并不是一成不变的，例如每 N 个广播事件 (Advertising event) 中会有一个广播事件使用高优先级。如果高优先级的广播事件发生在 Wi-Fi 时间片内，RF 的使用权可能会被 BLE 抢占。 +共存模块为每个模块的不同状态分配不同的优先级。每种状态下的优先级并不是一成不变的，例如对于 BLE，每 N 个广播事件 (Advertising event) 中会有一个广播事件使用高优先级。如果高优先级的广播事件发生在 Wi-Fi 时间片内，RF 的使用权可能会被 BLE 抢占。 .. only:: SOC_WIFI_SUPPORTED @@ -231,4 +253,4 @@ BLE MESH 共存状态描述 .. note:: - 由于共存配置选项依赖于蓝牙配置选项，所以请先打开蓝牙配置选项，然后在 Wi-Fi 配置选项中打开共存配置选项。 + 由于共存配置选项依赖于任何两个已启用的射频收发模块的存在，请在配置任何共存功能之前，确保至少使能了两个射频收发模块。