alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: fix xtal kconfig related description

Browse Source
This commit is contained in:
jingli 2022-07-13 11:24:04 +08:00
parent fcbaac4d42
commit 209cb1f8ee
2 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/get-started/start-project.rst
View File

@ -328,7 +328,7 @@ After startup and diagnostic logs scroll up, you should see "Hello world!" print
To exit IDF monitor use the shortcut ``Ctrl+]``.
.. only:: esp32
.. only:: esp32 or esp32c2
If IDF monitor fails shortly after the upload, or, if instead of the messages above, you see random garbage similar to what is given below, your board is likely using a 26 MHz crystal. Most development board designs use 40 MHz, so ESP-IDF uses this frequency as a default value.
@ -340,9 +340,18 @@ To exit IDF monitor use the shortcut ``Ctrl+]``.
If you have such a problem, do the following:
1. Exit the monitor.
2. Go back to `menuconfig`.
3. Go to Component config --> ESP32-specific --> Main XTAL frequency, then change :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` to 26 MHz.
4. After that, `build and flash` the application again.
2. Go back to ``menuconfig``.
3. Go to ``Component config`` --> ``Hardware Settings`` --> ``Main XTAL Config`` --> ``Main XTAL frequency``, then change :ref:`CONFIG_XTAL_FREQ_SEL` to 26 MHz.
4. After that, ``build and flash`` the application again.
In the current version of ESP-IDF, main XTAL frequencies supported by {IDF_TARGET_NAME} are as follows:
.. list::
:SOC_XTAL_SUPPORT_24M: - 24 MHz
:SOC_XTAL_SUPPORT_26M: - 26 MHz
:SOC_XTAL_SUPPORT_32M: - 32 MHz
:SOC_XTAL_SUPPORT_40M: - 40 MHz
.. note::

17
docs/zh_CN/get-started/start-project.rst
View File

@ -328,7 +328,7 @@
您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。
.. only:: esp32
.. only:: esp32 or esp32c2
如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（如下），很有可能是因为您的开发板采用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。
@ -340,9 +340,18 @@
此时，您可以：
1. 退出监视器。
2. 返回 `menuconfig`。
3. 进入 ``Component config`` --> ``ESP32-specific`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 设置为 26 MHz。
4. 重新 `编译和烧录` 应用程序。
2. 返回 ``menuconfig``。
3. 进入 ``Component config`` --> ``Hardware Settings`` --> ``Main XTAL Config`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_XTAL_FREQ_SEL` 设置为 26 MHz。
4. 重新 ``编译和烧录`` 应用程序。
在当前的 ESP-IDF 版本中，{IDF_TARGET_NAME} 支持的主晶振频率如下：
.. list::
:SOC_XTAL_SUPPORT_24M: - 24 MHz
:SOC_XTAL_SUPPORT_26M: - 26 MHz
:SOC_XTAL_SUPPORT_32M: - 32 MHz
:SOC_XTAL_SUPPORT_40M: - 40 MHz
.. note::