Merge branch 'bugfix/update_esp32s3_docs' into 'master'

Doc:Bugfix/update esp32s3 docs

See merge request espressif/esp-idf!15390
This commit is contained in:
Xue Yun Fei 2022-01-05 03:30:56 +00:00
commit ea73daa613
2 changed files with 141 additions and 9 deletions

View File

@ -10,7 +10,7 @@ Wi-Fi Driver
- Support WPA/WPA2/WPA3/WPA2-Enterprise and WPS - Support WPA/WPA2/WPA3/WPA2-Enterprise and WPS
- Support AMPDU, HT40, QoS and other key features - Support AMPDU, HT40, QoS and other key features
- Support Modem-sleep - Support Modem-sleep
- Support an Espressif-specific protocol which, in turn, supports up to **1 km** of data traffic - 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 - Up to 20 MBit/s TCP throughput and 30 MBit/s UDP throughput over the air
- Support Sniffer - Support Sniffer
- Support both fast scan and all-channel scan - Support both fast scan and all-channel scan
@ -1518,6 +1518,50 @@ The table below shows the best throughput results we got in Espressif's lab and
When the throughput is tested by iperf example, the sdkconfig is :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32c3`. When the throughput is tested by iperf example, the sdkconfig is :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32c3`.
.. only:: esp32s3
.. list-table::
:header-rows: 1
:widths: 10 10 10 15 20
* - Type/Throughput
- Air In Lab
- Shield-box
- Test Tool
- IDF Version (commit ID)
* - Raw 802.11 Packet RX
- N/A
- **130 MBit/s**
- Internal tool
- NA
* - Raw 802.11 Packet TX
- N/A
- **130 MBit/s**
- Internal tool
- NA
* - UDP RX
- 30 MBit/s
- 88 MBit/s
- iperf example
- 15575346
* - UDP TX
- 30 MBit/s
- 98 MBit/s
- iperf example
- 15575346
* - TCP RX
- 20 MBit/s
- 73 MBit/s
- iperf example
- 15575346
* - TCP TX
- 20 MBit/s
- 83 MBit/s
- iperf example
- 15575346
When the throughput is tested by iperf example, the sdkconfig is :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32s3`.
Wi-Fi 80211 Packet Send Wi-Fi 80211 Packet Send
--------------------------- ---------------------------
@ -1773,9 +1817,9 @@ Wi-Fi Fragment
supports Wi-Fi receiving fragment, but doesn't support Wi-Fi transmitting fragment. supports Wi-Fi receiving fragment, but doesn't support Wi-Fi transmitting fragment.
.. only:: esp32c3 .. only:: esp32c3 or esp32s3
ESP32C3 supports Wi-Fi receiving and transmitting fragment. {IDF_TARGET_NAME} supports Wi-Fi receiving and transmitting fragment.
WPS Enrollee WPS Enrollee
------------------------- -------------------------
@ -1898,10 +1942,32 @@ Increasing the size or number of the buffers mentioned above properly can improv
**CACHE:** **CACHE:**
- :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_SIZE` - :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_SIZE`
Configure the size of the instruction cache. Configure the size of the instruction Cache.
- :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_LINE_SIZE` - :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_LINE_SIZE`
Configure the width of the instruction cache bus. Configure the width of the instruction Cache bus.
.. only:: esp32s3
**CACHE:**
- :ref:`CONFIG_ESP32S3_INSTRUCTION_CACHE_SIZE`
Configure the size of the instruction Cache.
- :ref:`CONFIG_ESP32S3_INSTRUCTION_CACHE_LINE_SIZE`
Configure the size of the instruction Cache bus.
- :ref:`CONFIG_ESP32S3_ICACHE_ASSOCIATED_WAYS`
Configure the associated ways of the instruction Cache.
- :ref:`CONFIG_ESP32S3_DATA_CACHE_SIZE`
Configure the size of the Data Cache.
- :ref:`CONFIG_ESP32S3_DATA_CACHE_LINE_SIZE`
Configure the line size of the Data Cache.
- :ref:`CONFIG_ESP32S3_DCACHE_ASSOCIATED_WAYS`
Configure the associated ways of the Data Cache.
.. note:: .. note::
The buffer size mentioned above is fixed as 1.6 KB. The buffer size mentioned above is fixed as 1.6 KB.
@ -2346,7 +2412,7 @@ The parameters not mentioned in the following table should be set to the default
- **Minimum rank** - **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 that have no requirement for performance and the application requires lots of space. 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 that have no requirement for performance and the application requires lots of space.
.. only:: esp32c3 .. only:: esp32c3 or esp32s3
**Ranks:** **Ranks:**

View File

@ -1517,6 +1517,50 @@ AP 睡眠
使用 iperf example 测试吞吐量时sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32c3` 使用 iperf example 测试吞吐量时sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32c3`
.. only:: esp32s3
.. list-table::
:header-rows: 1
:widths: 10 10 10 15 20
* - 类型/吞吐量
- 实验室空气状况
- 屏蔽箱
- 测试工具
- IDF 版本 (commit ID)
* - 原始 802.11 数据包接收数据
- N/A
- **130 MBit/s**
- 内部工具
- N/A
* - 原始 802.11 数据包发送数据
- N/A
- **130 MBit/s**
- 内部工具
- N/A
* - UDP 接收数据
- 30 MBit/s
- 88 MBit/s
- iperf example
- 15575346
* - UDP 发送数据
- 30 MBit/s
- 98 MBit/s
- iperf example
- 15575346
* - TCP 接收数据
- 20 MBit/s
- 73 MBit/s
- iperf example
- 15575346
* - TCP 发送数据
- 20 MBit/s
- 83 MBit/s
- iperf example
- 15575346
使用 iperf example 测试吞吐量时sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32s3`
Wi-Fi 80211 数据包发送 Wi-Fi 80211 数据包发送
--------------------------- ---------------------------
@ -1772,9 +1816,9 @@ Wi-Fi 分片
支持 Wi-Fi 接收分片,但不支持 Wi-Fi 发送分片。 支持 Wi-Fi 接收分片,但不支持 Wi-Fi 发送分片。
.. only:: esp32c3 .. only:: esp32c3 or esp32s3
ESP32C3 支持 Wi-Fi 接收和发送分片。 {IDF_TARGET_NAME} 支持 Wi-Fi 接收和发送分片。
WPS 注册 WPS 注册
------------------------- -------------------------
@ -1902,6 +1946,28 @@ Wi-Fi 使用的堆内存峰值是 Wi-Fi 驱动程序 **理论上消耗的最大
- :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_LINE_SIZE` - :ref:`CONFIG_ESP32S2_INSTRUCTION_CACHE_LINE_SIZE`
配置指令缓存总线的宽度。 配置指令缓存总线的宽度。
.. only:: esp32s3
**缓存:**
- :ref:`CONFIG_ESP32S3_INSTRUCTION_CACHE_SIZE`
配置指令缓存的大小。
- :ref:`CONFIG_ESP32S3_INSTRUCTION_CACHE_LINE_SIZE`
配置指令缓存总线的宽度。
- :ref:`CONFIG_ESP32S3_ICACHE_ASSOCIATED_WAYS`
配置指令缓存相连方式.
- :ref:`CONFIG_ESP32S3_DATA_CACHE_SIZE`
配置数据缓存的大小.
- :ref:`CONFIG_ESP32S3_DATA_CACHE_LINE_SIZE`
配置数据缓存行大小.
- :ref:`CONFIG_ESP32S3_DCACHE_ASSOCIATED_WAYS`
配置数据缓存相连方式.
.. note:: .. note::
上述的缓冲区大小固定为 1.6 KB。 上述的缓冲区大小固定为 1.6 KB。
@ -2345,7 +2411,7 @@ Wi-Fi 使用的堆内存峰值是 Wi-Fi 驱动程序 **理论上消耗的最大
- **最小等级** - **最小等级**
{IDF_TARGET_NAME} 的最小配置等级。协议栈只使用运行所需的内存。适用于对性能没有要求,而应用程序需要大量内存的场景。 {IDF_TARGET_NAME} 的最小配置等级。协议栈只使用运行所需的内存。适用于对性能没有要求,而应用程序需要大量内存的场景。
.. only:: esp32c3 .. only:: esp32c3 or esp32s3
**等级:** **等级:**