mirror of
https://github.com/espressif/esp-idf.git
synced 2025-09-30 19:19:21 +00:00
Merge branch 'docs/update_folder_structure_for_5.1_migration' into 'master'
Docs: Update folder structure for 5.1 migration See merge request espressif/esp-idf!20754
This commit is contained in:
Wang Ning
@@ -9,4 +9,5 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
release-5.x/index
|
||||
release-5.x/5.0/index
|
||||
release-5.x/5.1/index
|
||||
|
||||
@@ -18,13 +18,3 @@
|
||||
storage
|
||||
system
|
||||
tools
|
||||
|
||||
.. Please create a separate file for each minor release, for example:
|
||||
|
||||
.. 从 5.0 迁移到 5.1
|
||||
.. -----------------
|
||||
|
||||
.. toctree::
|
||||
.. :maxdepth: 1
|
||||
|
||||
.. release-5.1
|
||||
@@ -61,7 +61,7 @@ SPI 以太网模块初始化
|
||||
|
||||
SPI 以太网模块的初始化过程已经简化。此前，您需要在实例化 SPI 以太网 MAC 之前，使用 :cpp:func:`spi_bus_add_device` 手动分配 SPI 设备。
|
||||
|
||||
现在，由于 SPI 设备已在内部分配，您无需再调用 :cpp:func:`spi_bus_add_device`。:cpp:class:`eth_dm9051_config_t`、:cpp:class:`eth_w5500_config_t` 和 :cpp:class:`eth_ksz8851snl_config_t` 配置结构体现已包含 SPI 设备配置成员（例如，可以微调可能依赖 PCB 设计的 SPI 时序）。``ETH_DM9051_DEFAULT_CONFIG``、``ETH_W5500_DEFAULT_CONFIG`` 和 ``ETH_KSZ8851SNL_DEFAULT_CONFIG`` 配置初始化宏也已接受新的参数输入。了解 SPI 以太网模块初始化示例，请查看 :doc:`以太网 API 参考指南<../../api-reference/network/esp_eth>`。
|
||||
现在，由于 SPI 设备已在内部分配，您无需再调用 :cpp:func:`spi_bus_add_device`。:cpp:class:`eth_dm9051_config_t`、:cpp:class:`eth_w5500_config_t` 和 :cpp:class:`eth_ksz8851snl_config_t` 配置结构体现已包含 SPI 设备配置成员（例如，可以微调可能依赖 PCB 设计的 SPI 时序）。``ETH_DM9051_DEFAULT_CONFIG``、``ETH_W5500_DEFAULT_CONFIG`` 和 ``ETH_KSZ8851SNL_DEFAULT_CONFIG`` 配置初始化宏也已接受新的参数输入。了解 SPI 以太网模块初始化示例，请查看 :doc:`以太网 API 参考指南<../../../api-reference/network/esp_eth>`。
|
||||
|
||||
|
||||
.. _tcpip-adapter:
|
||||
@@ -87,7 +87,7 @@ GPIO
|
||||
Sigma-Delta 调制器
|
||||
---------------------------------
|
||||
|
||||
Sigma-Delta 调制器的驱动现已更新为 :doc:`SDM <../../api-reference/peripherals/sdm>`。
|
||||
Sigma-Delta 调制器的驱动现已更新为 :doc:`SDM <../../../api-reference/peripherals/sdm>`。
|
||||
|
||||
- 新驱动中实现了工厂模式，SDM 通道都位于内部通道池中，因此用户无需手动将 SDM 通道配置到 GPIO 管脚。
|
||||
- SDM 通道会被自动分配。
|
||||
@@ -117,7 +117,7 @@ GPIO
|
||||
定时器组驱动
|
||||
-----------------------------------------
|
||||
|
||||
为统一和简化通用定时器的使用，定时器组驱动已更新为 :doc:`GPTimer <../../api-reference/peripherals/gptimer>`。
|
||||
为统一和简化通用定时器的使用，定时器组驱动已更新为 :doc:`GPTimer <../../../api-reference/peripherals/gptimer>`。
|
||||
|
||||
尽管我们推荐使用新的驱动 API， 旧版驱动仍然可用，其头文件引用路径为 ``driver/timer.h``。但是，引用 ``driver/timer.h`` 会默认触发如下编译警告，可通过配置 Kconfig 选项 :ref:`CONFIG_GPTIMER_SUPPRESS_DEPRECATE_WARN` 关闭该警告。
|
||||
|
||||
@@ -240,7 +240,7 @@ LEDC
|
||||
脉冲计数器 (PCNT) 驱动
|
||||
----------------------------------
|
||||
|
||||
为统一和简化 PCNT 外设，PCNT 驱动已更新，详见 :doc:`PCNT <../../api-reference/peripherals/pcnt>`。
|
||||
为统一和简化 PCNT 外设，PCNT 驱动已更新，详见 :doc:`PCNT <../../../api-reference/peripherals/pcnt>`。
|
||||
|
||||
尽管我们推荐使用新的驱动 API，旧版驱动仍然可用，保留在头文件引用路径 ``driver/pcnt.h`` 中。但是，引用路径 ``driver/pcnt.h`` 会默认触发如下编译警告，可通过配置 Kconfig 选项 :ref:`CONFIG_PCNT_SUPPRESS_DEPRECATE_WARN` 来关闭该警告。
|
||||
|
||||
@@ -294,14 +294,14 @@ LEDC
|
||||
|
||||
配置内容已更新。更新前，用户需要设置 ``clk_div`` 与 ``dac_offset``。更新后，用户仅需设置 ``tsens_range``。
|
||||
|
||||
温度传感器的使用过程也已更新。更新前，用户可通过 ``config->start->read_celsius`` 获取数据。更新后，用户需要通过 ``temperature_sensor_install`` 先安装温度传感器的驱动，测量完成后需卸载驱动，详情请参考 :doc:`Temperature Sensor <../../api-reference/peripherals/temp_sensor>`。
|
||||
温度传感器的使用过程也已更新。更新前，用户可通过 ``config->start->read_celsius`` 获取数据。更新后，用户需要通过 ``temperature_sensor_install`` 先安装温度传感器的驱动，测量完成后需卸载驱动，详情请参考 :doc:`Temperature Sensor <../../../api-reference/peripherals/temp_sensor>`。
|
||||
|
||||
.. only:: SOC_RMT_SUPPORTED
|
||||
|
||||
RMT 驱动
|
||||
----------------------
|
||||
|
||||
为统一和扩展 RMT 外设的使用，RMT 驱动已更新，详见 :doc:`RMT transceiver <../../api-reference/peripherals/rmt>`。
|
||||
为统一和扩展 RMT 外设的使用，RMT 驱动已更新，详见 :doc:`RMT transceiver <../../../api-reference/peripherals/rmt>`。
|
||||
|
||||
尽管我们建议使用新的驱动 API，旧版驱动仍然可用，保留在头文件引用路径 ``driver/rmt.h``中。但是，引用路径 ``driver/rmt.h`` 会默认触发如下编译警告，可通过配置 Kconfig 选项 :ref:`CONFIG_RMT_SUPPRESS_DEPRECATE_WARN` 来关闭该警告。
|
||||
|
||||
@@ -376,7 +376,7 @@ LCD
|
||||
MCPWM
|
||||
-----
|
||||
|
||||
MCPWM 驱动已更新（详见 :doc:`MCPWM <../../api-reference/peripherals/mcpwm>`）。同时，旧版驱动已被弃用。
|
||||
MCPWM 驱动已更新（详见 :doc:`MCPWM <../../../api-reference/peripherals/mcpwm>`）。同时，旧版驱动已被弃用。
|
||||
|
||||
新驱动中，每个 MCPWM 子模块相互独立，用户可以自由进行资源连接。
|
||||
|
||||
@@ -454,13 +454,13 @@ LCD
|
||||
I2S 驱动
|
||||
-----------------------
|
||||
|
||||
旧版 I2S 驱动在支持 ESP32-C3 和 ESP32-S3 新功能时暴露了很多缺点，为解决这些缺点，I2S 驱动已更新（请参考:doc:`I2S Driver <../../api-reference/peripherals/i2s>`）。用户可以通过引用不同 I2S 模式对应的头文件来使用新版驱动的 API，如 :component_file:`driver/include/driver/i2s_std.h`， :component_file:`driver/include/driver/i2s_pdm.h` 以及 :component_file:`driver/include/driver/i2s_tdm.h`。
|
||||
旧版 I2S 驱动在支持 ESP32-C3 和 ESP32-S3 新功能时暴露了很多缺点，为解决这些缺点，I2S 驱动已更新（请参考:doc:`I2S Driver <../../../api-reference/peripherals/i2s>`）。用户可以通过引用不同 I2S 模式对应的头文件来使用新版驱动的 API，如 :component_file:`driver/include/driver/i2s_std.h`， :component_file:`driver/include/driver/i2s_pdm.h` 以及 :component_file:`driver/include/driver/i2s_tdm.h`。
|
||||
|
||||
为保证前向兼容，旧版驱动的 API 仍然在 :component_file:`driver/deprecated/driver/i2s.h` 中可用。但使用旧版 API 会触发编译警告，该警告可通过配置 Kconfig 选项 :ref:`CONFIG_I2S_SUPPRESS_DEPRECATE_WARN` 来关闭。
|
||||
|
||||
以下是更新后的 I2S 文件概况。
|
||||
|
||||
.. figure:: ../../../_static/diagrams/i2s/i2s_file_structure.png
|
||||
.. figure:: ../../../../_static/diagrams/i2s/i2s_file_structure.png
|
||||
:align: center
|
||||
:alt: I2S File Structure
|
||||
|
||||
@@ -46,7 +46,7 @@ IDF v4.x 版本中已不再使用以下组件，这些组件已弃用：
|
||||
不再支持 OpenSSL-API 组件。IDF Component Registry 中也没有该组件。请直接使用 :doc:`ESP-TLS </api-reference/protocols/esp_tls>` 或 :component:`mbedtls` API。
|
||||
|
||||
.. note::
|
||||
不再支持 esp_adc_cal 组件。 新的 adc 校准驱动在 esp_adc 组件中。旧版 adc 校准驱动已被迁移进 esp_adc 组件中。 要使用旧版 esp_adc_cal 驱动接口，你应该在 CMakeLists.txt 文件的组件依赖列表中增加 esp_adc 。更多细节请查看 :doc:`Peripherals Migration Guide </migration-guides/release-5.x/peripherals>`。
|
||||
不再支持 esp_adc_cal 组件。 新的 adc 校准驱动在 esp_adc 组件中。旧版 adc 校准驱动已被迁移进 esp_adc 组件中。 要使用旧版 esp_adc_cal 驱动接口，你应该在 CMakeLists.txt 文件的组件依赖列表中增加 esp_adc 。更多细节请查看 :doc:`Peripherals Migration Guide </migration-guides/release-5.x/5.0/peripherals>`。
|
||||
|
||||
版本更新后无需目标组件，因此以下目标组件也已经从 ESP-IDF 中删除：
|
||||
|
||||
@@ -90,7 +90,7 @@ SOC 依赖性
|
||||
应用跟踪
|
||||
--------
|
||||
|
||||
其中一个时间戳源已从定时器组驱动改为新的 :doc:`GPTimer <../../api-reference/peripherals/gptimer>`。Kconfig 选项已重新命名，例如 ``APPTRACE_SV_TS_SOURCE_TIMER00`` 已更改为 ``APPTRACE_SV_TS_SOURCE_GPTIMER``。用户已无需选择组和定时器 ID。
|
||||
其中一个时间戳源已从定时器组驱动改为新的 :doc:`GPTimer <../../../api-reference/peripherals/gptimer>`。Kconfig 选项已重新命名，例如 ``APPTRACE_SV_TS_SOURCE_TIMER00`` 已更改为 ``APPTRACE_SV_TS_SOURCE_GPTIMER``。用户已无需选择组和定时器 ID。
|
||||
|
||||
esp_timer
|
||||
-----------
|
||||
9
docs/zh_CN/migration-guides/release-5.x/5.1/index.rst
Normal file
9
docs/zh_CN/migration-guides/release-5.x/5.1/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
从 5.0 迁移到 5.1
|
||||
-----------------
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
peripherals
|
||||
@@ -0,0 +1,4 @@
|
||||
外设
|
||||
============
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
Reference in New Issue
Block a user