Skip to content

Commit 9f0c8e7

Browse files
esp-lrhesp-lrh
committed
docs(coex): update rf coexistence documents
- remove BLE connecting state in coexistence scenario - remove WIFI section in H2 docs
1 parent c7a0e45 commit 9f0c8e7

File tree

2 files changed

+136
-124
lines changed

2 files changed

+136
-124
lines changed

‎docs/en/api-guides/coexist.rst‎

Lines changed: 68 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,32 @@ Supported Coexistence Scenario for {IDF_TARGET_NAME}
1616

1717
.. table:: Supported Features of Wi-Fi and BLE Coexistence
1818

19-
+-------+--------+-----------+-----+------------+-----------+----------+
20-
| |BLE |
21-
+ +-----+------------+-----------+----------+
22-
| |Scan |Advertising |Connecting |Connected |
23-
+-------+--------+-----------+-----+------------+-----------+----------+
24-
| Wi-Fi |STA |Scan |Y |Y |Y |Y |
25-
+ + +-----------+-----+------------+-----------+----------+
26-
| | |Connecting |Y |Y |Y |Y |
27-
+ + +-----------+-----+------------+-----------+----------+
28-
| | |Connected |Y |Y |Y |Y |
29-
+ +--------+-----------+-----+------------+-----------+----------+
30-
| |SOFTAP |TX Beacon |Y |Y |Y |Y |
31-
+ + +-----------+-----+------------+-----------+----------+
32-
| | |Connecting |C1 |C1 |C1 |C1 |
33-
+ + +-----------+-----+------------+-----------+----------+
34-
| | |Connected |C1 |C1 |C1 |C1 |
35-
+ +--------+-----------+-----+------------+-----------+----------+
36-
| |Sniffer |RX |C1 |C1 |C1 |C1 |
37-
+ +--------+-----------+-----+------------+-----------+----------+
38-
| |ESP-NOW |RX |S |S |S |S |
39-
+ + +-----------+-----+------------+-----------+----------+
40-
| | |TX |Y |Y |Y |Y |
41-
+-------+--------+-----------+-----+------------+-----------+----------+
42-
43-
44-
.. only:: esp32
19+
+-------+--------+-----------+-----+------------+----------+
20+
| |BLE |
21+
+ +-----+------------+----------+
22+
| |Scan |Advertising |Connected |
23+
+-------+--------+-----------+-----+------------+----------+
24+
| Wi-Fi |STA |Scan |Y |Y |Y |
25+
+ + +-----------+-----+------------+----------+
26+
| | |Connecting |Y |Y |Y |
27+
+ + +-----------+-----+------------+----------+
28+
| | |Connected |Y |Y |Y |
29+
+ +--------+-----------+-----+------------+----------+
30+
| |SOFTAP |TX Beacon |Y |Y |Y |
31+
+ + +-----------+-----+------------+----------+
32+
| | |Connecting |C1 |C1 |C1 |
33+
+ + +-----------+-----+------------+----------+
34+
| | |Connected |C1 |C1 |C1 |
35+
+ +--------+-----------+-----+------------+----------+
36+
| |Sniffer |RX |C1 |C1 |C1 |
37+
+ +--------+-----------+-----+------------+----------+
38+
| |ESP-NOW |RX |S |S |S |
39+
+ + +-----------+-----+------------+----------+
40+
| | |TX |Y |Y |Y |
41+
+-------+--------+-----------+-----+------------+----------+
42+
43+
44+
.. only:: SOC_WIFI_SUPPORTED and SOC_BT_CLASSIC_SUPPORTED
4545

4646
.. table:: Supported Features of Wi-Fi and Classic Bluetooth (BT) Coexistence
4747

@@ -97,24 +97,26 @@ Supported Coexistence Scenario for {IDF_TARGET_NAME}
9797

9898
.. table:: Supported Features of IEEE 802.15.4 (Thread / Zigbee) and BLE Coexistence
9999

100-
+-----------------+-------------+-----+------------+-----------+----------+
101-
| |BLE |
102-
+ +-----+------------+-----------+----------+
103-
| |Scan |Advertising |Connecting |Connected |
104-
+-----------------+-------------+-----+------------+-----------+----------+
105-
| Thread / Zigbee |Scan |X |Y |Y |Y |
106-
+ +-------------+-----+------------+-----------+----------+
107-
| |Router |X |Y |Y |Y |
108-
+ +-------------+-----+------------+-----------+----------+
109-
| |End Device |C1 |Y |Y |Y |
110-
+-----------------+-------------+-----+------------+-----------+----------+
100+
+-----------------+-------------+-----+------------+----------+
101+
| |BLE |
102+
+ +-----+------------+----------+
103+
| |Scan |Advertising |Connected |
104+
+-----------------+-------------+-----+------------+----------+
105+
| Thread / Zigbee |Scan |X |Y |Y |
106+
+ +-------------+-----+------------+----------+
107+
| |Router |X |Y |Y |
108+
+ +-------------+-----+------------+----------+
109+
| |End Device |C1 |Y |Y |
110+
+-----------------+-------------+-----+------------+----------+
111111

112112
.. note::
113113

114-
- Y: supported and the performance is stable
115-
- C1: supported but the performance is unstable
116-
- X: not supported
117-
- S: supported and the performance is stable in STA mode, otherwise not supported
114+
.. list::
115+
116+
- Y: supported and the performance is stable
117+
- C1: supported but the performance is unstable
118+
- X: not supported
119+
:SOC_WIFI_SUPPORTED: - S: supported and the performance is stable in STA mode, otherwise not supported
118120

119121
.. only:: SOC_IEEE802154_SUPPORTED
120122

@@ -168,44 +170,48 @@ The RF resource allocation mechanism is based on priority. As shown below, Wi-Fi
168170
Coexistence Policy
169171
^^^^^^^^^^^^^^^^^^^^^^^^^^^
170172

171-
Coexistence Period and Time Slice
172-
""""""""""""""""""""""""""""""""""""""""
173+
.. only:: SOC_WIFI_SUPPORTED and SOC_BT_SUPPORTED
173174

174-
.. only:: esp32
175+
Coexistence Period and Time Slice
176+
""""""""""""""""""""""""""""""""""""""""
175177

176-
Wi-Fi, BT, and BLE have their fixed time slice to use the RF. A coexistence period is divided into 3 time slices in the order of Wi-Fi, BT, and BLE. In the Wi-Fi slice, Wi-Fi's request to the coexistence arbitration module will have higher priority. Similarly, BT/BLE can enjoy higher priority at their own time slices. The duration of the coexistence period and the proportion of each time slice are divided into four categories according to the Wi-Fi status:
178+
.. only:: SOC_BLE_SUPPORTED and SOC_BT_CLASSIC_SUPPORTED
177179

180+
Wi-Fi, BT, and BLE have their fixed time slice to use the RF. A coexistence period is divided into 3 time slices in the order of Wi-Fi, BT, and BLE. In the Wi-Fi slice, Wi-Fi's request to the coexistence arbitration module will have higher priority. Similarly, BT/BLE can enjoy higher priority at their own time slices. The duration of the coexistence period and the proportion of each time slice are divided into four categories according to the Wi-Fi status:
178181

179-
.. only:: SOC_WIFI_SUPPORTED and SOC_BLE_SUPPORTED and not esp32
180182

181-
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:
183+
.. only:: not SOC_BT_CLASSIC_SUPPORTED
182184

183-
.. list::
185+
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:
184186

185-
:esp32: 1) IDLE status: the coexistence of BT and BLE is controlled by Bluetooth module.
186-
:SOC_WIFI_SUPPORTED and SOC_BLE_SUPPORTED and not esp32: 1) IDLE status: RF module is controlled by Bluetooth module.
187-
#) CONNECTED status: the coexistence period starts at the Target Beacon Transmission Time (TBTT) and is more than 100 ms.
188-
#) SCAN status: Wi-Fi slice and coexistence period are longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.
189-
#) CONNECTING status: Wi-Fi slice is longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.
187+
.. list::
190188

189+
:SOC_BLE_SUPPORTED and SOC_BT_CLASSIC_SUPPORTED: 1) IDLE status: the coexistence of BT and BLE is controlled by Bluetooth module.
190+
:not SOC_BT_CLASSIC_SUPPORTED: 1) IDLE status: RF module is controlled by Bluetooth module.
191+
#) CONNECTED status: the coexistence period starts at the Target Beacon Transmission Time (TBTT) and is more than 100 ms.
192+
#) SCAN status: Wi-Fi slice and coexistence period are longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.
193+
#) CONNECTING status: Wi-Fi slice is longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.
191194

192-
According to the coexistence logic, different coexistence periods and time slice strategies will be selected based on the Wi-Fi and Bluetooth usage scenarios. A Coexistence policy corresponding to a certain usage scenarios is called a "coexistence scheme". For example, the scenario of Wi-Fi CONNECTED and BLE CONNECTED has a corresponding coexistence scheme. In this scheme, the time slices of Wi-Fi and BLE in a coexistence period each account for 50%. The time allocation is shown in the following figure:
193195

194-
.. figure:: ../../_static/coexist_wifi_connected_and_ble_connected_time_slice.png
195-
:align: center
196-
:alt: Time Slice Under the Status of Wi-Fi CONNECTED and BLE CONNECTED
197-
:figclass: align-center
196+
According to the coexistence logic, different coexistence periods and time slice strategies will be selected based on the Wi-Fi and Bluetooth usage scenarios. A Coexistence policy corresponding to a certain usage scenarios is called a "coexistence scheme". For example, the scenario of Wi-Fi CONNECTED and BLE CONNECTED has a corresponding coexistence scheme. In this scheme, the time slices of Wi-Fi and BLE in a coexistence period each account for 50%. The time allocation is shown in the following figure:
198197

199-
Time Slice Under the Status of Wi-Fi CONNECTED and BLE CONNECTED
198+
.. figure:: ../../_static/coexist_wifi_connected_and_ble_connected_time_slice.png
199+
:align: center
200+
:alt: Time Slice Under the Status of Wi-Fi CONNECTED and BLE CONNECTED
201+
:figclass: align-center
202+
203+
Time Slice Under the Status of Wi-Fi CONNECTED and BLE CONNECTED
200204

201205
.. only:: SOC_IEEE802154_SUPPORTED
202206

203207
The IEEE 802.15.4 module requests RF resources based on pre-assigned priorities. Normal receive operations are assigned the lowest priority, meaning Wi-Fi and BLE will take over the RF whenever needed, while 802.15.4 can only receive during the remaining time. Other 802.15.4 operations, such as transmitting or receiving ACKs and transmitting or receiving at given time, are assigned higher priorities. However, their access to RF ultimately depends on the priorities of Wi-Fi and BLE operations at that moment.
204208

205-
Dynamic Priority
206-
""""""""""""""""""""""""""""
209+
.. only:: SOC_WIFI_SUPPORTED and SOC_BT_SUPPORTED
210+
211+
Dynamic Priority
212+
""""""""""""""""""""""""""""
207213

208-
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.
214+
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.
209215

210216
.. only:: SOC_WIFI_SUPPORTED
211217

0 commit comments

Comments
 (0)