Skip to content

Commit f6b8ad8

Browse files
committed
feat(docs): initial migration guide for idf 6.x
1 parent c63f51d commit f6b8ad8

File tree

6 files changed

+96
-0
lines changed

6 files changed

+96
-0
lines changed

docs/en/migration-guides/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,11 @@ ESP-IDF 5.x Migration Guide
1515
release-5.x/5.3/index
1616
release-5.x/5.4/index
1717
release-5.x/5.5/index
18+
19+
ESP-IDF 6.x Migration Guide
20+
===========================
21+
22+
.. toctree::
23+
:maxdepth: 1
24+
25+
release-6.x/6.0/index
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Migration from 5.5 to 6.0
2+
-------------------------
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
peripherals
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Peripherals
2+
===========
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
Common Changes
7+
--------------
8+
9+
All drivers' ``io_loop_back`` configuration have been removed
10+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+
12+
Different driver objects can share the same GPIO number, enabling more complex functionalities. For example, you can bind the TX and RX channels of the RMT peripheral to the same GPIO to simulate 1-Wire bus read and write timing. In previous versions, you needed to configure the ``io_loop_back`` setting in the driver to achieve this "loopback" functionality. Now, this configuration has been removed. Simply configuring the same GPIO number in different drivers will achieve the same functionality.
13+
14+
RMT
15+
---
16+
17+
The ``io_od_mode`` member in the :cpp:type:`rmt_tx_channel_config_t` configuration structure has been removed. If you want to use open-drain mode, you need to manually call the :func:`gpio_od_enable` function.
18+
19+
MCPWM
20+
-----
21+
22+
The ``io_od_mode`` member in the :cpp:type:`mcpwm_generator_config_t` configuration structure has been removed. If you want to use open-drain mode, you need to manually call the :func:`gpio_od_enable` function.
23+
24+
The ``pull_up`` and ``pull_down`` members have been removed from the following configuration structures. You need to manually call the :func:`gpio_set_pull_mode` function to configure the pull-up and pull-down resistors for the IO:
25+
26+
.. list::
27+
28+
- :cpp:type:`mcpwm_generator_config_t`
29+
- :cpp:type:`mcpwm_gpio_fault_config_t`
30+
- :cpp:type:`mcpwm_gpio_sync_src_config_t`
31+
- :cpp:type:`mcpwm_capture_channel_config_t`

docs/zh_CN/migration-guides/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,11 @@
1515
release-5.x/5.3/index
1616
release-5.x/5.4/index
1717
release-5.x/5.5/index
18+
19+
迁移到 ESP-IDF 6.x
20+
-------------------
21+
22+
.. toctree::
23+
:maxdepth: 1
24+
25+
release-6.x/6.0/index
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
从 5.5 迁移到 6.0
2+
-----------------
3+
4+
:link_to_translation:`en:[English]`
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
peripherals
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
外设驱动
2+
========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
公共变化
7+
--------
8+
9+
所有驱动的 ``io_loop_back`` 配置已被移除
10+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+
12+
不同的驱动对象可以共享同一个 GPIO 编号,联合起来可以实现更加复杂的功能。比如将 RMT 外设的 TX 通道和 RX 通道绑定在同一个 GPIO 上,进而模拟单总线的读写时序。在以前的版本中,你需要在驱动的配置中额外设置 ``io_loop_back`` 来实现这种“回环”功能,现在,这个配置已经被移除。不同的驱动只需要在配置中设置相同的 GPIO 编号就能实现这个功能。
13+
14+
RMT
15+
---
16+
17+
:cpp:type:`rmt_tx_channel_config_t` 配置结构体中的 ``io_od_mode`` 已经被移除。如果想要使用开漏模式,你需要手动调用 GPIO 驱动中的 :func:`gpio_od_enable` 函数。
18+
19+
MCPWM
20+
-----
21+
22+
:cpp:type:`mcpwm_generator_config_t` 配置结构体中的 ``io_od_mode`` 已经被移除。如果想要使用开漏模式,你需要手动调用 GPIO 驱动中的 :func:`gpio_od_enable` 函数。
23+
24+
以下配置结构体中的 ``pull_up`` 和 ``pull_down`` 成员已经被移除,你需要手动调用 GPIO 驱动中的 :func:`gpio_set_pull_mode` 函数来配置 IO 上拉和下拉电阻:
25+
26+
.. list::
27+
28+
- :cpp:type:`mcpwm_generator_config_t`
29+
- :cpp:type:`mcpwm_gpio_fault_config_t`
30+
- :cpp:type:`mcpwm_gpio_sync_src_config_t`
31+
- :cpp:type:`mcpwm_capture_channel_config_t`

0 commit comments

Comments
 (0)