Merge branch 'fix_jtag_debugging_update_doc_esp32c6' into 'master'

doc: fix usb-jtag configure efuse section

See merge request espressif/esp-idf!22166
This commit is contained in:
Erhan Kurubas
2023-02-02 17:06:46 +08:00
3 changed files with 14 additions and 18 deletions

View File

@@ -15,12 +15,12 @@ For guidance about which JTAG interface to select when using OpenOCD with {IDF_T
.. only:: esp32c3 .. only:: esp32c3
Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the {IDF_TARGET_NAME}. JTAG interface can then be connected to |jtag-gpio-list|. Note that USB CDC functionality of USB_SERIAL_JTAG will still be usable, i.e., flashing and monitoring over USB CDC will still work. Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the {IDF_TARGET_NAME}. JTAG interface can then be connected to |jtag-gpio-list|. Note that USB CDC functionality of USB_SERIAL_JTAG will still be usable, i.e., flashing and monitoring over USB CDC will still work.
.. only:: esp32s3 or esp32c6 .. only:: esp32s3 or esp32c6
- Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the {IDF_TARGET_NAME}. JTAG interface can then be connected to |jtag-gpio-list|. Note that USB CDC functionality of USB_SERIAL_JTAG will still be usable, i.e., flashing and monitoring over USB CDC will still work. - Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the {IDF_TARGET_NAME}. JTAG interface can then be connected to |jtag-gpio-list|. Note that USB CDC functionality of USB_SERIAL_JTAG will still be usable, i.e., flashing and monitoring over USB CDC will still work.
- Burning ``{IDF_TARGET_JTAG_SEL_EFUSE}`` eFuse will enable selection of JTAG interface by a strapping pin, |jtag-sel-gpio|. If the strapping pin is low when {IDF_TARGET_NAME} is reset, JTAG interface will use |jtag-gpio-list|. If the strapping pin is high, USB_SERIAL_JTAG will be used as the JTAG interface. - Burning ``{IDF_TARGET_JTAG_SEL_EFUSE}`` eFuse will enable selection of JTAG interface by a strapping pin, |jtag-sel-gpio|. If the strapping pin is low when {IDF_TARGET_NAME} is reset, JTAG interface will use |jtag-gpio-list|. If the strapping pin is high, USB_SERIAL_JTAG will be used as the JTAG interface.
.. warning:: .. warning::
Burning eFuses is an irreversible operation, so please consider the above option before starting the process. Burning eFuses is an irreversible operation, so please consider the above option before starting the process.

View File

@@ -2,31 +2,25 @@
================== ==================
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
关于适配 OpenOCD 和 {IDF_TARGET_NAME} 的 JTAG 接口选择问题,请参考 :ref:`jtag-debugging-selecting-jtag-adapter` 章节,确保 JTAG 适配器能够与 OpenOCD 和 {IDF_TARGET_NAME} 一同工作。然后按照以下三个步骤进行设置,使其正常工作。 {IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE"}
关于适配 OpenOCD 和 {IDF_TARGET_NAME} 的 JTAG 接口选择问题,请参考 :ref:`jtag-debugging-selecting-jtag-adapter` 章节。然后按照以下步骤进行设置,使其正常工作。
.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED and not esp32c3 .. only:: SOC_USB_SERIAL_JTAG_SUPPORTED
配置 eFuse 配置 eFuse
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
{IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_JTAG 外设 <configure-builtin-jtag>`。要使用外部 JTAG 适配器,需将 JTAG 接口切换至 GPIO 管脚。您可以使用 ``espefuse.py`` 工具来烧录 eFuse以完成接口转换。 {IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_JTAG 外设 <configure-builtin-jtag>`。要使用外部 JTAG 适配器,需将 JTAG 接口切换至 GPIO 管脚。您可以使用 ``espefuse.py`` 工具来烧录 eFuse以完成接口转换。
- 烧录 ``DIS_USB_JTAG`` eFuse 后USB_SERIAL_JTAG 和 CPU 的 JTAG 接口之间的连接将被永久禁用,此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意烧录后USB_SERIAL_JTAG 的 USB CDC 功能仍然可用,即仍然可以通过 USB CDC 进行烧录和查看日志。 .. only:: esp32c3
- 烧录 ``STRAP_JTAG_SEL`` eFuse 后JTAG 接口的选择将由 strapping 管脚 |jtag-sel-gpio| 来决定。{IDF_TARGET_NAME} 复位时,如果该 strapping 管脚为低电平JTAG 接口将使用 |jtag-gpio-list|如果为高电平USB_SERIAL_JTAG 将被用作 JTAG 接口。
.. warning:: 烧录 ``DIS_USB_JTAG`` eFuse 后USB_SERIAL_JTAG 和 {IDF_TARGET_NAME} 的 JTAG 接口之间的连接将被永久禁用,此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意烧录后USB_SERIAL_JTAG 的 USB CDC 功能仍然可用,即仍然可以通过 USB CDC 进行烧录和查看日志。
请注意,烧录 eFuse 是一项不可逆的操作,请在开始前谨慎考虑以上选项。
.. only:: esp32s3 or esp32c6
.. only:: esp32c3 - 烧录 ``DIS_USB_JTAG`` eFuse 后USB_SERIAL_JTAG 和 {IDF_TARGET_NAME} 的 JTAG 接口之间的连接将被永久禁用,此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意烧录后USB_SERIAL_JTAG 的 USB CDC 功能仍然可用,即仍然可以通过 USB CDC 进行烧录和查看日志。
- 烧录 ``{IDF_TARGET_JTAG_SEL_EFUSE}`` eFuse 后JTAG 接口的选择将由 strapping 管脚 |jtag-sel-gpio| 来决定。{IDF_TARGET_NAME} 复位时,如果该 strapping 管脚为低电平JTAG 接口将使用 |jtag-gpio-list|如果为高电平USB_SERIAL_JTAG 将被用作 JTAG 接口。
配置 eFuse
^^^^^^^^^^^^^^^^
{IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_JTAG 外设 <configure-builtin-jtag>`。要使用外部 JTAG 适配器,需将 JTAG 接口切换至 GPIO 管脚。您可以使用 ``espefuse.py`` 工具来烧录 eFuse以完成接口转换。
烧录 ``DIS_USB_JTAG`` eFuse 后USB_SERIAL_JTAG 和 CPU 的 JTAG 接口之间的连接将被永久禁用,此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意烧录后USB_SERIAL_JTAG 的 USB CDC 功能仍然可用,即仍然可以通过 USB CDC 进行烧录和查看日志。
.. warning:: .. warning::
请注意,烧录 eFuse 是一项不可逆的操作,请在开始前谨慎考虑以上选项。 请注意,烧录 eFuse 是一项不可逆的操作,请在开始前谨慎考虑以上选项。

View File

@@ -206,13 +206,15 @@ OpenOCD 安装完成后就可以配置 {IDF_TARGET_NAME} 目标(即带 JTAG
其中 OpenOCD 的烧写命令 ``program_esp`` 格式如下: 其中 OpenOCD 的烧写命令 ``program_esp`` 格式如下:
``program_esp <image_file> <offset> [verify] [reset] [exit]`` ``program_esp <image_file> <offset> [verify] [reset] [exit] [compress] [encrypt]``
- ``image_file`` - 程序镜像文件存放的路径 - ``image_file`` - 程序镜像文件存放的路径
- ``offset`` - 镜像烧写到 flash 中的偏移地址 - ``offset`` - 镜像烧写到 flash 中的偏移地址
- ``verify`` - 烧写完成后校验 flash 中的内容(可选) - ``verify`` - 烧写完成后校验 flash 中的内容(可选)
- ``reset`` - 烧写完成后重启目标(可选) - ``reset`` - 烧写完成后重启目标(可选)
- ``exit`` - 烧写完成后退出 OpenOCD可选 - ``exit`` - 烧写完成后退出 OpenOCD可选
- ``compress`` - 烧写开始前压缩镜像文件(可选)
- ``encrypt`` - 烧写到 flash 前加密二进制文件,与 ``idf.py encrypted-flash`` 功能相同(可选)
现在可以调试应用程序了,请按照以下章节中的步骤进行操作。 现在可以调试应用程序了,请按照以下章节中的步骤进行操作。