diff --git a/docs/en/index.rst b/docs/en/index.rst index 5fc39188a2..023562e9b9 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -62,6 +62,7 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf H/W Reference API Guides + ESP-IDF 5.0 Migration Guides Libraries and Frameworks Contribute Versions diff --git a/docs/en/migration-guides/index.rst b/docs/en/migration-guides/index.rst new file mode 100644 index 0000000000..64a4e40b7c --- /dev/null +++ b/docs/en/migration-guides/index.rst @@ -0,0 +1,8 @@ +ESP-IDF 5.0 Migration Guides +**************************** +:link_to_translation:`zh_CN:[中文]` + +.. toctree:: + :maxdepth: 1 + + Peripherals diff --git a/docs/en/migration-guides/peripherals.rst b/docs/en/migration-guides/peripherals.rst new file mode 100644 index 0000000000..357df1d5b6 --- /dev/null +++ b/docs/en/migration-guides/peripherals.rst @@ -0,0 +1,9 @@ +Migrate Peripherals to ESP-IDF 5.0 +================================== + +Peripheral Clock Gating +----------------------- + +As usual, peripheral clock gating is still handled by driver itself, users don't need to take care of the peripheral module clock gating. + +However, for advanced users who implement their own drivers based on ``hal`` and ``soc`` components, the previous clock gating include path has been changed from ``driver/periph_ctrl.h`` to ``esp_private/periph_ctrl.h``. diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst index f7f39628b4..52d381f611 100644 --- a/docs/zh_CN/index.rst +++ b/docs/zh_CN/index.rst @@ -62,6 +62,7 @@ ESP-IDF 编程指南 API 参考 H/W 参考 API 指南 + ESP-IDF 5.0 迁移指南 Libraries and Frameworks 贡献代码 版本 diff --git a/docs/zh_CN/migration-guides/index.rst b/docs/zh_CN/migration-guides/index.rst new file mode 100644 index 0000000000..8aca392256 --- /dev/null +++ b/docs/zh_CN/migration-guides/index.rst @@ -0,0 +1,8 @@ +ESP-IDF 5.0 迁移指南 +******************** +:link_to_translation:`zh_CN:[中文]` + +.. toctree:: + :maxdepth: 1 + + 外设 diff --git a/docs/zh_CN/migration-guides/peripherals.rst b/docs/zh_CN/migration-guides/peripherals.rst new file mode 100644 index 0000000000..986d95906d --- /dev/null +++ b/docs/zh_CN/migration-guides/peripherals.rst @@ -0,0 +1 @@ +.. include:: ../../en/migration-guides/peripherals.rst