Merge branch 'doc/update_wifi_amsdu_docs' into 'master'

doc: update wifi amsdu docs

Closes DOC-4069

See merge request espressif/esp-idf!21230
This commit is contained in:
Mu Hai Dong 2022-12-02 14:22:48 +08:00
commit 8574ec3bd3
2 changed files with 47 additions and 12 deletions

View File

@ -7,7 +7,7 @@ Wi-Fi Driver
------------------------------------
The following features are supported:
.. only:: esp32 or esp32s2 or esp32c3 or esp32s3
.. only:: esp32 or esp32s2 or esp32s3
- 4 virtual Wi-Fi interfaces, which are STA, AP, Sniffer and reserved.
- Station-only mode, AP-only mode, station/AP-coexistence mode
@ -22,13 +22,28 @@ The following features are supported:
- Multiple antennas
- Channel state information
.. only:: esp32c3
- 4 virtual Wi-Fi interfaces, which are STA, AP, Sniffer and reserved.
- Station-only mode, AP-only mode, station/AP-coexistence mode
- IEEE 802.11b, IEEE 802.11g, IEEE 802.11n, and APIs to configure the protocol mode
- WPA/WPA2/WPA3/WPA2-Enterprise/WPA3-Enterprise/WAPI/WPS and DPP
- AMPDU, HT40, QoS, and other key features
- Modem-sleep
- The Espressif-specific ESP-NOW protocol and Long Range mode, which supports up to **1 km** of data traffic
- Up to 20 MBit/s TCP throughput and 30 MBit/s UDP throughput over the air
- Sniffer
- Both fast scan and all-channel scan
- Multiple antennas
- Channel state information
.. only:: esp32c2
- 3 virtual Wi-Fi interfaces, which are STA, AP and Sniffer.
- Station-only mode, AP-only mode, station/AP-coexistence mode
- IEEE 802.11b, IEEE 802.11g, IEEE 802.11n, and APIs to configure the protocol mode
- WPA/WPA2/WPA3/WPA2-Enterprise/WPA3-Enterprise/WPS and DPP
- AMSDU, AMPDU, QoS, and other key features
- AMPDU, QoS, and other key features
- Modem-sleep
- Up to 20 MBit/s TCP throughput and 30 MBit/s UDP throughput over the air
- Sniffer
@ -2164,10 +2179,12 @@ Theoretically, the higher priority AC has better performance than the lower prio
- Avoid using more than two precedences supported by different AMPDUs, e.g., when socket A uses precedence 0, socket B uses precedence 1, and socket C uses precedence 2. This can be a bad design because it may need much more memory. To be specific, the Wi-Fi driver may generate a Block Ack session for each precedence and it needs more memory if the Block Ack session is set up.
Wi-Fi AMSDU
-------------------------
.. only:: SOC_SPIRAM_SUPPORTED
{IDF_TARGET_NAME} supports receiving and transmitting AMSDU.
Wi-Fi AMSDU
-------------------------
{IDF_TARGET_NAME} supports receiving and transmitting AMSDU. AMSDU TX is disabled by default, since enable AMSDU TX need more internal memory. Select :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` to enable AMSDU Tx feature, it depends on :ref:`CONFIG_SPIRAM`.
Wi-Fi Fragment
-------------------------
@ -2849,7 +2866,7 @@ The parameters not mentioned in the following table should be set to the default
- **Minimum rank**
This is the minimum configuration rank of {IDF_TARGET_NAME}. The protocol stack only uses the necessary memory for running. It is suitable for scenarios where there is no requirement for performance and the application requires lots of space.
.. only:: esp32 or esp32s2 or esp32s3
.. only:: SOC_SPIRAM_SUPPORTED
Using PSRAM
++++++++++++++++++++++++++++

View File

@ -7,7 +7,7 @@
------------------------------------
{IDF_TARGET_NAME} 支持以下 Wi-Fi 功能:
.. only:: esp32 or esp32s2 or esp32c3 or esp32s3
.. only:: esp32 or esp32s2 or esp32s3
- 支持 4 个虚拟接口,即 STA、AP、Sniffer 和 reserved。
- 支持仅 station 模式、仅 AP 模式、station/AP 共存模式
@ -22,13 +22,28 @@
- 支持多个天线
- 支持获取信道状态信息
.. only:: esp32c3
- 支持 4 个虚拟接口,即 STA、AP、Sniffer 和 reserved。
- 支持仅 station 模式、仅 AP 模式、station/AP 共存模式
- 支持使用 IEEE 802.11b、IEEE 802.11g、IEEE 802.11n 和 API 配置协议模式
- 支持 WPA/WPA2/WPA3/WPA2-企业版/WPA3-企业版/WAPI/WPS 和 DPP
- 支持 AMPDU、HT40、QoS 以及其它主要功能
- 支持 Modem-sleep
- 支持乐鑫专属协议,可实现 **1 km** 数据通信量
- 空中数据传输最高可达 20 MBit/s TCP 吞吐量和 30 MBit/s UDP 吞吐量
- 支持 Sniffer
- 支持快速扫描和全信道扫描
- 支持多个天线
- 支持获取信道状态信息
.. only:: esp32c2
- 支持 3 个虚拟接口即STA、AP 和 Sniffer。
- 支持仅 station 模式、仅 AP 模式、station/AP 共存模式
- 支持使用 IEEE 802.11b、IEEE 802.11g、IEEE 802.11n 和 API 配置协议模式
- 支持 WPA/WPA2/WPA3/WPA2-企业版/WPA3-企业版/WPS 和 DPP
- 支持 AMSDU、AMPDU、QoS 以及其它主要功能
- 支持 AMPDU、QoS 以及其它主要功能
- 支持 Modem-sleep
- 空中数据传输最高可达 20 MBit/s TCP 吞吐量和 30 MBit/s UDP 吞吐量
- 支持 Sniffer
@ -2165,10 +2180,13 @@ Wi-Fi 协议中定义了四个 AC (访问类别),每个 AC 有各自的优
- 避免使用 AMPDU 支持的、两个以上的不同优先级,比如 socket A 使用优先级 0socket B 使用优先级 1socket C 使用优先级 2。因为可能需要更多的内存不是好的设计。具体来说Wi-Fi 驱动程序可能会为每个优先级生成一个 Block Ack 会话,如果设置了 Block Ack 会话,则需要更多内存。
Wi-Fi AMSDU
-------------------------
.. only:: SOC_SPIRAM_SUPPORTED
Wi-Fi AMSDU
-------------------------
{IDF_TARGET_NAME} 支持接收和发送 AMSDU。开启 AMSDU 发送比较消耗内存,默认不开启 AMSDU 发送。可通过选项 :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` 使能 AMSDU 发送功能, 但是使能 AMSDU 发送依赖于 :ref:`CONFIG_SPIRAM`
{IDF_TARGET_NAME} 支持接收和发送 AMSDU。
Wi-Fi 分片
-------------------------
@ -2850,7 +2868,7 @@ Wi-Fi 使用的堆内存峰值是 Wi-Fi 驱动程序 **理论上消耗的最大
- **最小等级**
{IDF_TARGET_NAME} 的最小配置等级。协议栈只使用运行所需的内存。适用于对性能没有要求,而应用程序需要大量内存的场景。
.. only:: esp32 or esp32s2 or esp32s3
.. only:: SOC_SPIRAM_SUPPORTED
使用 PSRAM
++++++++++++++++++++++++++++