From 42888d2919fcbb8f7f2b373ecbdb0d3666c3242e Mon Sep 17 00:00:00 2001 From: muhaidong Date: Thu, 24 Nov 2022 16:53:07 +0800 Subject: [PATCH] doc: update wifi amsdu docs --- docs/en/api-guides/wifi.rst | 18 ++++++++++++++++-- docs/zh_CN/api-guides/wifi.rst | 20 +++++++++++++++++--- 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index c894bdf97f..5b9e49c8f4 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -9,7 +9,7 @@ Wi-Fi Driver - Support station-only mode, AP-only mode, station/AP-coexistence mode - Support IEEE 802.11b, IEEE 802.11g, IEEE 802.11n, and APIs to configure the protocol mode - Support WPA/WPA2/WPA3/WPA2-Enterprise and WPS -- Support AMPDU, HT40, QoS and other key features +- Support AMSDU, AMPDU, HT40, QoS and other key features - Support Modem-sleep - Support 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 @@ -2026,7 +2026,21 @@ Theoretically the higher priority AC has better performance than the low priorit Wi-Fi AMSDU ------------------------- -{IDF_TARGET_NAME} supports receiving and transmitting AMSDU. +.. only:: esp32c3 + + {IDF_TARGET_NAME} supports receiving AMSDU. + +.. only:: esp32 + + {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_ESP32_SPIRAM_SUPPORT`. + +.. only:: esp32s2 + + {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_ESP32S2_SPIRAM_SUPPORT`. + +.. only:: esp32s3 + + {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_ESP32S3_SPIRAM_SUPPORT`. Wi-Fi Fragment ------------------------- diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst index 5a4889b2a6..5568ce069b 100644 --- a/docs/zh_CN/api-guides/wifi.rst +++ b/docs/zh_CN/api-guides/wifi.rst @@ -7,8 +7,8 @@ - 支持 4 个虚拟接口,即STA、AP、Sniffer 和 reserved。 - 支持仅 station 模式、仅 AP 模式、station/AP 共存模式 - 支持使用 IEEE 802.11B、IEEE 802.11G、IEEE 802.11N 和 API 配置协议模式 -- 支持 WPA/WPA2/WPA2-企业版和 WPS -- 支持 AMPDU、HT40、QoS 以及其它主要功能 +- 支持 WPA/WPA2/WPA3/WPA2-企业版和 WPS +- 支持 AMSDU、AMPDU、HT40、QoS 以及其它主要功能 - 支持 Modem-sleep - 支持乐鑫专属协议,可实现 **1 km** 数据通信量 - 空中数据传输最高可达 20 MBit/s TCP 吞吐量和 30 MBit/s UDP 吞吐量 @@ -1947,7 +1947,21 @@ Wi-Fi 协议中定义了四个 AC (访问类别),每个 AC 有各自的优 Wi-Fi AMSDU ------------------------- -{IDF_TARGET_NAME} 支持接收和发送 AMSDU。 +.. only:: esp32c3 + + {IDF_TARGET_NAME} 支持接收 AMSDU。 + +.. only:: esp32 + + {IDF_TARGET_NAME} 支持接收和发送 AMSDU。开启 AMSDU 发送比较消耗内存,默认不开启 AMSDU 发送。可通过选项 :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` 使能 AMSDU 发送功能, 但是使能 AMSDU 发送依赖于 :ref:`CONFIG_ESP32_SPIRAM_SUPPORT` 。 + +.. only:: esp32s2 + + {IDF_TARGET_NAME} 支持接收和发送 AMSDU。开启 AMSDU 发送比较消耗内存,默认不开启 AMSDU 发送。可通过选项 :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` 使能 AMSDU 发送功能, 但是使能 AMSDU 发送依赖于 :ref:`CONFIG_ESP32S2_SPIRAM_SUPPORT` 。 + +.. only:: esp32s3 + + {IDF_TARGET_NAME} 支持接收和发送 AMSDU。开启 AMSDU 发送比较消耗内存,默认不开启 AMSDU 发送。可通过选项 :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` 使能 AMSDU 发送功能, 但是使能 AMSDU 发送依赖于 :ref:`CONFIG_ESP32S3_SPIRAM_SUPPORT` 。 Wi-Fi 分片 -------------------------