mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
docs(compatibility): add new chips and improve translations
- Add ESP32-C5, ESP32-C61, ESP32-H4 initial support versions to COMPATIBILITY.md - Fix ESP32-C2 v1.2 required version from v5.1 to v5.2 in COMPATIBILITY_CN.md - Improve README_CN.md translation to be more accurate and concise
This commit is contained in:
Xiao Xufeng
+28
-10
@@ -2,27 +2,33 @@
|
||||
|
||||
* [中文版](./COMPATIBILITY_CN.md)
|
||||
|
||||
Espressif keeps improving the performance of its SoCs by providing new chip revisions. However, some of the improvements require special software support. Some of the software supports are even mandatory for the chip revisions to run normally.
|
||||
This document describes the ESP-IDF support and compatibility for Espressif SoC series and revisions. The compatibility documents on release branches may be out-of-date. Please check the [Compatibility file on master](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY.md) or ESP-IDF Release Notes for the latest chip support updates.
|
||||
|
||||
This document describes the compatibility between ESP-IDF releases and Espressif SoC revisions.
|
||||
## SoC Series Support
|
||||
|
||||
NOTE: This document on release branches may be out-of-date. Check the [Compatibility file on master](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY.md) for the most accurate information.
|
||||
Before official support, each SoC series typically provides `preview` versions on specific branches or tags for early development. Please note that preview support for these chips will end after the official release version is published, and will not be maintained afterwards. For mass production, please use the officially released versions.
|
||||
|
||||
After the first chip of a series completes support and passes testing, ESP-IDF will release the first official support version for that series. Chips of this series must run on this official version or higher.
|
||||
|
||||
## Chip Revision Support
|
||||
|
||||
After a chip series is officially supported, Espressif continues to release new chip revisions to improve performance. However, some performance improvements in new chip revisions depend on special software support, and sometimes new chip revisions must run under specific software versions to function normally.
|
||||
|
||||
See [Compatibility Advisory for Chip Revision Numbering Scheme](https://www.espressif.com/sites/default/files/advisory_downloads/AR2022-005%20Compatibility%20Advisory%20for%20Chip%20Revision%20Numbering%20%20Scheme.pdf) on the versioning of Espressif SoC revisions.
|
||||
|
||||
You can run `esptool chip-id` to detect the series and revision of an SoC. See [SoC Errata](https://www.espressif.com/en/support/documents/technical-documents?keys=errata) for more on how to distinguish between chip revisions, and the improvements provided by chip revisions. And run `idf.py --version` to know the version of current ESP-IDF.
|
||||
You can run `esptool chip-id` to detect the chip series and revision (use `esptool.py chip_id` for ESP-IDF v5.5 and older). See [SoC Errata](https://www.espressif.com/en/support/documents/technical-documents?keys=errata) for more on distinguishing chip revisions and revision improvements. Run `idf.py --version` to check the current ESP-IDF version.
|
||||
|
||||
## ESP-IDF Support for Different Chip Revisions
|
||||
There are `Recommended` and `Required` versions of ESP-IDF for each chip revision:
|
||||
|
||||
The sections below show the requirements to ESP-IDF version of chip revisions. Each chip revision corresponds to specific `Recommended` and `Required` versions of ESP-IDF:
|
||||
- `Recommended`: indicates the earliest ESP-IDF release version that currently gives the most complete support for utilizing all performance improvements of the chip revision. Using this version, software can maximize the benefits of the chip revision improvements. Running binary compiled with ESP-IDF below the `Recommended` version of a chip revision, software may not benefit from some of the bugfix/features provided by the chip revision. The chip will have almost the same behavior as its previous revision. If a chip revision involves many software updates, they may be released across multiple versions, so the recommended version may be updated periodically.
|
||||
|
||||
- `Recommended`: shows from which version of ESP-IDF you can make use of all the improvements of the chip revision. Running binary compiled with ESP-IDF below the `Recommended` version of a chip revision, software may not benefit from the bugfix/features provided by the chip revision. The chip will have almost the same behavior as its previous revision.
|
||||
|
||||
- `Required`: shows the minimum version required to run the chip revision normally. Running binary compiled below the `Required` version, the binary may have unpredictable behavior.
|
||||
- `Required`: indicates the minimum ESP-IDF version required for the chip revision to run normally. Running binary compiled below the `Required` version, the binary may have unpredictable behavior.
|
||||
|
||||
Though the software can make use of all the features of a chip revision, if its version is higher than the `Recommended` version of the chip, it is still recommended to use the latest bugfix version of the release branch. The latest bugfix version fixes a number of issues and helps improve product stability.
|
||||
|
||||
For example, if we have a chip, whose `Required`/`Recommended` version of `release/v5.1` branch is `v5.1.2`/`v5.1.4`, and the latest release on that branch is `v5.1.6`. Then the chip will not boot up with ESP-IDF `v5.1`-`v5.1.1` or will have unpredictable behavior, and application may not make use of all benefits of the chip, when running with ESP-IDF `v5.1.2` or `v5.1.3`. Though `v5.1.4` well supports the chip revision, it is still recommended to upgrade ESP-IDF to `v5.1.6`.
|
||||
For example, if we have a chip, whose `Required`/`Recommended` version of `release/v5.1` branch is `v5.1.2`/`v5.1.4`, and the latest release on that branch is `v5.1.6`. Then the chip will not boot up with ESP-IDF `v5.1`-`v5.1.1` or will have unpredictable behavior, and application may not make use of all benefits of the chip, when running with ESP-IDF `v5.1.2` or `v5.1.3`. Though `v5.1.4` will supports the chip revision, it is still recommended to upgrade ESP-IDF to `v5.1.6`.
|
||||
|
||||
## Detailed ESP-IDF Support for Chip Revisions
|
||||
|
||||
### ESP32
|
||||
|
||||
@@ -146,6 +152,18 @@ Supported since ESP-IDF v5.1.
|
||||
|
||||
Supported since ESP-IDF v5.3.
|
||||
|
||||
### ESP32-C5
|
||||
|
||||
Supported since ESP-IDF v5.5.1.
|
||||
|
||||
### ESP32-C61
|
||||
|
||||
Supported since ESP-IDF v5.5.1.
|
||||
|
||||
### ESP32-H4
|
||||
|
||||
Preview support since ESP-IDF v6.0.
|
||||
|
||||
## What If the ESP-IDF Version Is Lower than the `Required` Version?
|
||||
|
||||
Latest ESP-IDF versions can prevent from downloading to, or even execute binaries on unsupported chips. ESP-IDF of versions v4.4.5+, v5.0.1+, v5.1 and above have both esptool download check and bootloader loading check against the chip revision. While ESP-IDF v4.3.5 has only esptool downloading check.
|
||||
|
||||
+28
-10
@@ -2,28 +2,34 @@
|
||||
|
||||
* [English Version](./COMPATIBILITY.md)
|
||||
|
||||
为不断提高芯片性能，乐鑫会为其芯片发布新版本。但新芯片版本中的某些性能提升依赖特殊的软件支持，有时候新芯片版本必须在一定的软件版本下才能正常运行。
|
||||
本文档介绍了 ESP-IDF 版本对乐鑫芯片系列的支持和兼容性。各分支上的兼容性文档可能不是最新版本，请参考 [master 分支上的兼容性文件](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY_CN.md) 或者 ESP-IDF 项目的 Release Notes 来了解最新的芯片支持动态。
|
||||
|
||||
本文档介绍了具体 ESP-IDF 版本与乐鑫芯片版本之间的兼容性情况。
|
||||
## 芯片系列的支持
|
||||
|
||||
注意：各分支上的兼容性文档可能不是最新版本，请参考 [master 分支上的兼容性文件](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY_CN.md) 以获取最新信息。
|
||||
每个芯片系列在正式支持之前，通常都会在某个分支或者 tag 上提供 `预览版本` 供用户进行早期开发，请注意预览版本对该芯片的支持在正式版本发布后就会结束，后续不会继续维护对该芯片的支持，量产请以正式发布的版本为准。
|
||||
|
||||
在该系列首个芯片完成支持并通过测试之后，ESP-IDF 会发布该系列的首个正式支持版本，该系列芯片必须运行在该正式版本或更高版本。
|
||||
|
||||
## 芯片版本的支持
|
||||
|
||||
在芯片系列正式支持之后，为不断提高芯片性能，乐鑫会为其芯片发布新版本。但新芯片版本中的某些性能提升依赖特殊的软件支持，有时候新芯片版本必须在一定的软件版本下才能正常运行。
|
||||
|
||||
有关乐鑫芯片版本的编码方式，请参考 [关于芯片版本 (Chip Revision) 编码方式的兼容性公告](https://www.espressif.com/sites/default/files/advisory_downloads/AR2022-005%20%E5%85%B3%E4%BA%8E%E8%8A%AF%E7%89%87%E7%89%88%E6%9C%AC%E7%BC%96%E7%A0%81%E6%96%B9%E5%BC%8F%20%28Chip%20Revision%29%20%E7%9A%84%E5%85%BC%E5%AE%B9%E6%80%A7%E5%85%AC%E5%91%8A.pdf)。
|
||||
|
||||
运行 `esptool chip-id` 可查看芯片系列及其版本。有关区分芯片版本及版本改进内容的更多信息，请参考 [芯片勘误表](https://www.espressif.com.cn/zh-hans/support/documents/technical-documents?keys=%E5%8B%98%E8%AF%AF%E8%A1%A8)。运行 `idf.py --version` 可查看当前的 ESP-IDF 版本。
|
||||
运行 `esptool chip-id` 可查看芯片系列及其版本（在 ESP-IDF v5.5 或者更早的版本上使用 `esptool.py chip_id`）。有关区分芯片版本及版本改进内容的更多信息，请参考 [芯片勘误表](https://www.espressif.com.cn/zh-hans/support/documents/technical-documents?keys=%E5%8B%98%E8%AF%AF%E8%A1%A8)。运行 `idf.py --version` 可查看当前的 ESP-IDF 版本。
|
||||
|
||||
## ESP-IDF 对各芯片版本的支持
|
||||
每个芯片版本都有对应的 ESP-IDF `推荐版本` 和 `需求版本`：
|
||||
|
||||
下文介绍了 ESP-IDF 对各芯片版本的支持情况，每个芯片版本都有对应的 ESP-IDF `推荐版本` 和 `需求版本`：
|
||||
- `推荐版本`：表示当前最早能够对完整利用该芯片版本的性能提升提供最多支持的 ESP-IDF 发布版本。使用此版本，软件可以最大化地利用该芯片版本的改进。如果在该芯片版本上运行低于 `推荐版本` 的 ESP-IDF 来编译二进制文件，软件可能无法利用一部分该芯片版本修复的错误或新增的功能，芯片行为将与其上一版本几乎相同。如果此芯片版本涉及到的软件升级较多，可能会分在多个版本中发布，因此，推荐版本可能会不定期更新。
|
||||
|
||||
- `推荐版本`：表示从该版本的 ESP-IDF 开始，软件可以利用芯片版本提升的性能。如果在该芯片版本上运行低于 `推荐版本` 的 ESP-IDF 来编译二进制文件，软件可能无法利用该芯片版本修复的错误或新增的功能，芯片行为将与其上一版本几乎相同。
|
||||
|
||||
- `需求版本`：表示该芯片版本正常运行所需的最低 ESP-IDF 版本。如果在该芯片版本上运行低于 `需求版本` 的 ESP-IDF 来编译二进制文件，可能会出现不可预测的芯片行为。
|
||||
- `需求版本`：表示该芯片版本正常运行所需的最低 ESP-IDF 版本。如果在该芯片版本上运行低于 `需求版本` 的 ESP-IDF 来编译二进制文件，可能会出现不可预测的行为。
|
||||
|
||||
即便使用的软件版本已高于该芯片版本的对应 `推荐版本`，软件已经能够利用该芯片版本的所有功能，我们仍建议用户升级到该发布分支的最新 bugfix 版本。新的 bugfix 版本修复了一些问题，有助于提升产品稳定性。
|
||||
|
||||
例如，对于某一芯片版本，其 `release/v5.1` 分支的 `需求版本` 和 `推荐版本` 分别是 `v5.1.2` 和 `v5.1.4`，而该分支的最新版本是 `v5.1.6`。那么，在使用 ESP-IDF `v5.1` - `v5.1.1` 时，芯片将无法启动，或会出现不可预测的行为，而在使用 ESP-IDF `v5.1.2` 或 `v5.1.3` 时，应用程序可能无法使用芯片的部分性能。此外，虽然 `v5.1.4` 已支持该芯片版本，但仍建议将 ESP-IDF 升级到 `v5.1.6`。
|
||||
|
||||
## ESP-IDF 对各芯片版本的支持详情
|
||||
|
||||
### ESP32
|
||||
|
||||
#### v0.0、v1.0 和 v3.0
|
||||
@@ -94,7 +100,7 @@
|
||||
|------------------------|-------------|----------|
|
||||
| release/v5.0 | v5.0.7+ | v5.0 |
|
||||
| release/v5.1 | v5.1.4+ | v5.1 |
|
||||
| release/v5.2 | v5.2.2+ | v5.1 |
|
||||
| release/v5.2 | v5.2.2+ | v5.2 |
|
||||
| release/v5.3 及以上 | v5.3+ | v5.3 |
|
||||
|
||||
#### v2.0
|
||||
@@ -146,6 +152,18 @@
|
||||
|
||||
从 ESP-IDF v5.3 开始支持。
|
||||
|
||||
### ESP32-C5
|
||||
|
||||
从 ESP-IDF v5.5.1 开始支持。
|
||||
|
||||
### ESP32-C61
|
||||
|
||||
从 ESP-IDF v5.5.1 开始支持。
|
||||
|
||||
### ESP32-H4
|
||||
|
||||
从 ESP-IDF v6.0 开始提供预览支持。
|
||||
|
||||
## 如果 ESP-IDF 版本低于 `需求版本` 会出现什么情况？
|
||||
|
||||
使用最新的 ESP-IDF 版本时，软件会阻止下载二进制文件到不支持的芯片版本上，甚至可以防止二进制文件在不支持的芯片版本上被执行。v4.4.5+、v5.0.1+、v5.1 及以上版本的 ESP-IDF 都支持针对芯片版本的 esptool 下载检查和引导加载器加载检查，但 ESP-IDF v4.3.5 只支持 esptool 下载检查。
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ ESP-IDF 是乐鑫官方推出的物联网开发框架，支持 Windows、Linux
|
||||
|
||||
# ESP-IDF 与乐鑫芯片
|
||||
|
||||
建议参考 [ESP-IDF 版本与乐鑫芯片版本兼容性](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY_CN.md)，了解 ESP-IDF 版本与各芯片版本之间的兼容性。
|
||||
请参考 [ESP-IDF 版本与乐鑫芯片版本兼容性](https://github.com/espressif/esp-idf/blob/master/COMPATIBILITY_CN.md) 了解 ESP-IDF 版本与芯片版本之间的兼容性详情。
|
||||
|
||||
对于 2016 年之前发布的乐鑫芯片（包括 ESP8266 和 ESP8285），请参考 [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK)。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user