From b2e302fc979a2ec96e1375bd69a45a0e297f557e Mon Sep 17 00:00:00 2001 From: muhaidong Date: Tue, 13 Dec 2022 19:32:03 +0800 Subject: [PATCH 1/3] docs: update wifi amsdu receiving docs --- docs/en/api-guides/wifi.rst | 29 +++++++++-------------------- docs/zh_CN/api-guides/wifi.rst | 27 ++++++++------------------- 2 files changed, 17 insertions(+), 39 deletions(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 26aca5d629..c9f633a527 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -7,7 +7,7 @@ Wi-Fi Driver ------------------------------------ The following features are supported: -.. only:: esp32 or esp32s2 or esp32s3 +.. only:: esp32 or esp32s2 or esp32c3 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,21 +22,6 @@ 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. @@ -2205,12 +2190,16 @@ 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:: not SOC_SPIRAM_SUPPORTED + + {IDF_TARGET_NAME} supports receiving AMSDU. + .. only:: SOC_SPIRAM_SUPPORTED - 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`. + {IDF_TARGET_NAME} supports receiving and transmitting AMSDU. AMSDU TX is disabled by default, since enable AMSDU TX need more memory. Select :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` to enable AMSDU Tx feature, it depends on :ref:`CONFIG_SPIRAM`. Wi-Fi Fragment ------------------------- diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst index 1a45890fe9..a27a9df39c 100644 --- a/docs/zh_CN/api-guides/wifi.rst +++ b/docs/zh_CN/api-guides/wifi.rst @@ -7,7 +7,7 @@ ------------------------------------ {IDF_TARGET_NAME} 支持以下 Wi-Fi 功能： -.. only:: esp32 or esp32s2 or esp32s3 +.. only:: esp32 or esp32s2 or esp32c3 or esp32s3 - 支持 4 个虚拟接口，即 STA、AP、Sniffer 和 reserved。 - 支持仅 station 模式、仅 AP 模式、station/AP 共存模式 @@ -22,21 +22,6 @@ - 支持多个天线 - 支持获取信道状态信息 -.. 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。 @@ -2205,10 +2190,14 @@ Wi-Fi 协议中定义了四个 AC （访问类别），每个 AC 有各自的优 - 避免使用 AMPDU 支持的、两个以上的不同优先级，比如 socket A 使用优先级 0，socket B 使用优先级 1，socket C 使用优先级 2。因为可能需要更多的内存，不是好的设计。具体来说，Wi-Fi 驱动程序可能会为每个优先级生成一个 Block Ack 会话，如果设置了 Block Ack 会话，则需要更多内存。 -.. only:: SOC_SPIRAM_SUPPORTED +Wi-Fi AMSDU +------------------------- - Wi-Fi AMSDU - ------------------------- +.. only:: not SOC_SPIRAM_SUPPORTED + + {IDF_TARGET_NAME} 支持接收 AMSDU。 + +.. only:: SOC_SPIRAM_SUPPORTED {IDF_TARGET_NAME} 支持接收和发送 AMSDU。开启 AMSDU 发送比较消耗内存，默认不开启 AMSDU 发送。可通过选项 :ref:`CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED` 使能 AMSDU 发送功能， 但是使能 AMSDU 发送依赖于 :ref:`CONFIG_SPIRAM` 。 From fe576d316e07b4f5d7b3d6970b1796efc3267779 Mon Sep 17 00:00:00 2001 From: muhaidong Date: Tue, 13 Dec 2022 19:48:30 +0800 Subject: [PATCH 2/3] docs: add some details for wifi scan description --- docs/en/api-guides/wifi.rst | 2 +- docs/zh_CN/api-guides/wifi.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index c9f633a527..7b953a54cd 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -1241,7 +1241,7 @@ API :cpp:func:`esp_wifi_set_config()` can be used to configure the station. And * - bssid - This is valid only when bssid_set is 1; see field “bssid_set”. * - channel - - If the channel is 0, the station scans the channel 1 ~ N to search for the target AP; otherwise, the station starts by scanning the channel whose value is the same as that of the “channel” field, and then scans others to find the target AP. If you do not know which channel the target AP is running on, set it to 0. + - If the channel is 0, the station scans the channel 1 ~ N to search for the target AP; otherwise, the station starts by scanning the channel whose value is the same as that of the “channel” field, and then scans the channel 1 ~ N but skip the specific channel to find the target AP. For example, if the channel is 3, the scan order will be 3, 1, 2, 4,..., N. If you do not know which channel the target AP is running on, set it to 0. * - sort_method - This field is only for WIFI_ALL_CHANNEL_SCAN. diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst index a27a9df39c..7f136710db 100644 --- a/docs/zh_CN/api-guides/wifi.rst +++ b/docs/zh_CN/api-guides/wifi.rst @@ -1241,7 +1241,7 @@ API :cpp:func:`esp_wifi_set_config()` 可用于配置 station。配置的参数 * - bssid - 只有当 bssid_set 为 1 时有效。见字段 “bssid_set”。 * - channel - - 该字段为 0 时，station 扫描信道 1 ~ N 寻找目标 AP；否则，station 首先扫描值与 “channel” 字段相同的信道，再扫描其他信道。如果您不知道目标 AP 在哪个信道，请将该字段设置为 0。 + - 该字段为 0 时，station 扫描信道 1 ~ N 寻找目标 AP；否则，station 首先扫描值与 “channel” 字段相同的信道，再扫描其他信道。比如，当该字段设置为 3 时，扫描顺序为 3，1，2，...，N 。如果您不知道目标 AP 在哪个信道，请将该字段设置为 0。 * - sort_method - 该字段仅用于 WIFI_ALL_CHANNEL_SCAN 模式。 From f855d0790d6f77fbd6395f46b9e8ee1020b528d6 Mon Sep 17 00:00:00 2001 From: muhaidong Date: Tue, 10 Jan 2023 20:55:31 +0800 Subject: [PATCH 3/3] docs: update ftm docs --- docs/en/api-guides/wifi.rst | 2 +- docs/zh_CN/api-guides/wifi.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 7b953a54cd..45ce216d17 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -1620,7 +1620,7 @@ Current implementation of 802.11k includes support for beacon measurement report Refer ESP-IDF example :idf_file:`examples/wifi/roaming/README.md` to set up and use these APIs. Example code only demonstrates how these APIs can be used, and the application should define its own algorithm and cases as required. -.. only:: esp32s2 or esp32c3 +.. only:: SOC_WIFI_FTM_SUPPORT Wi-Fi Location ------------------------------- diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst index 7f136710db..76e956b3f1 100644 --- a/docs/zh_CN/api-guides/wifi.rst +++ b/docs/zh_CN/api-guides/wifi.rst @@ -1620,7 +1620,7 @@ WPA2-Enterprise 是企业无线网络的安全认证机制。在连接到接入 请参考 IDF 示例程序 :idf_file:`examples/wifi/roaming/README.md` 来设置和使用这些 API。示例代码只演示了如何使用这些 API，应用程序应根据需要定义自己的算法和案例。 -.. only:: esp32s2 or esp32c3 +.. only:: SOC_WIFI_FTM_SUPPORT Wi-Fi Location -------------------------------