From 7cb9629590c26b1e2ff0af19b68263d7e146e733 Mon Sep 17 00:00:00 2001 From: Mo Fei Fei Date: Tue, 30 Aug 2022 11:06:57 +0800 Subject: [PATCH] Docs: update the JTAG select eFuse description in configure-other-jtag.rst (backport v4.4) --- .../jtag-debugging/configure-other-jtag.rst | 34 +++++++++++++------ .../jtag-debugging/configure-other-jtag.rst | 32 +++++++++++------ 2 files changed, 45 insertions(+), 21 deletions(-) diff --git a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst index 364eb2364d60..13c66c0d8aaf 100644 --- a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst @@ -1,23 +1,35 @@ -Configure Other JTAG Interface -============================== +Configure Other JTAG Interfaces +=============================== :link_to_translation:`zh_CN:[中文]` -For guidance about which JTAG interface to select to enable operation with OpenOCD and {IDF_TARGET_NAME}, refer to section :ref:`jtag-debugging-selecting-jtag-adapter`. Then follow the three configuration steps below to get it working. +For guidance about which JTAG interface to select when using OpenOCD with {IDF_TARGET_NAME}, refer to the section :ref:`jtag-debugging-selecting-jtag-adapter`. Then follow the configuration steps below to get it working. -.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED +.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED and not esp32c3 - Configure eFuses - ^^^^^^^^^^^^^^^^ + Configure eFuses + ^^^^^^^^^^^^^^^^ - By default, {IDF_TARGET_NAME} JTAG interface is connected to the :doc:`built-in USB_SERIAL_JTAG peripheral `. To use an external JTAG adapter instead, you need to switch the JTAG interface to the GPIO pins. This can be done by burning eFuses using ``espefuse.py`` tool. + By default, {IDF_TARGET_NAME} JTAG interface is connected to the :doc:`built-in USB_SERIAL_JTAG peripheral `. To use an external JTAG adapter instead, you need to switch the JTAG interface to the GPIO pins. This can be done by burning eFuses using ``espefuse.py`` tool. - Burning eFuses is an irreversible operation, so consider both options below before starting the process. + - Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the CPU. 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 ``STRAP_JTAG_SEL`` 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 ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the CPU. 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. + .. warning:: + Burning eFuses is an irreversible operation, so please consider the above options before starting the process. - - Burning ``JTAG_SEL_ENABLE`` 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. +.. only:: esp32c3 + + Configure eFuses + ^^^^^^^^^^^^^^^^ + + By default, {IDF_TARGET_NAME} JTAG interface is connected to the :doc:`built-in USB_SERIAL_JTAG peripheral `. To use an external JTAG adapter instead, you need to switch the JTAG interface to the GPIO pins. This can be done by burning eFuses using ``espefuse.py`` tool. + + Burning ``DIS_USB_JTAG`` eFuse will permanently disable the connection between USB_SERIAL_JTAG and the JTAG port of the CPU. 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. + + .. warning:: + Burning eFuses is an irreversible operation, so please consider the above option before starting the process. Configure Hardware ^^^^^^^^^^^^^^^^^^ @@ -45,4 +57,4 @@ Connect Connect JTAG interface to the computer. Power on {IDF_TARGET_NAME} and JTAG interface boards. Check if the JTAG interface is visible on the computer. -To carry on with debugging environment setup, proceed to section :ref:`jtag-debugging-run-openocd`. \ No newline at end of file +To carry on with debugging environment setup, proceed to section :ref:`jtag-debugging-run-openocd`. diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst index 69e998acbdcc..2f9d1654db33 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst @@ -1,24 +1,36 @@ -配置其它 JTAG 接口 +配置其他 JTAG 接口 ================== :link_to_translation:`en:[English]` 关于适配 OpenOCD 和 {IDF_TARGET_NAME} 的 JTAG 接口选择问题，请参考 :ref:`jtag-debugging-selecting-jtag-adapter` 章节，确保 JTAG 适配器能够与 OpenOCD 和 {IDF_TARGET_NAME} 一同工作。然后按照以下三个步骤进行设置，使其正常工作。 -.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED +.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED and not esp32c3 - 配置 eFuses - ^^^^^^^^^^^^^^^^ + 配置 eFuse + ^^^^^^^^^^^^^^^^ - {IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_JTAG 外设 `。要使用外部 JTAG 适配器，需将 JTAG 接口切换至 GPIO 管脚。您可以使用 `espefuse.py` 工具来烧录 eFuse，以完成接口转换。 + {IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_JTAG 外设 `。要使用外部 JTAG 适配器，需将 JTAG 接口切换至 GPIO 管脚。您可以使用 ``espefuse.py`` 工具来烧录 eFuse，以完成接口转换。 - 烧录 eFuse 是一项不可逆的操作，所以在开始之前，请考虑以下两点： + - 烧录 ``DIS_USB_JTAG`` eFuse 后，USB_SERIAL_JTAG 和 CPU 的 JTAG 接口之间的连接将被永久禁用，此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意，烧录后，USB_SERIAL_JTAG 的 USB CDC 功能仍然可用，即仍然可以通过 USB CDC 进行烧录和查看日志。 + - 烧录 ``STRAP_JTAG_SEL`` eFuse 后，JTAG 接口的选择将由 strapping 管脚 |jtag-sel-gpio| 来决定。{IDF_TARGET_NAME} 复位时，如果该 strapping 管脚为低电平，JTAG 接口将使用 |jtag-gpio-list|，如果为高电平，USB_SERIAL_JTAG 将被用作 JTAG 接口。 - - 烧录 `DIS_USB_JTAG` eFuse 后，USB_SERIAL_JTAG 和 CPU 的 JTAG 接口之间的连接将被永久禁用，此后您可以将 JTAG 接口连接到 |jtag-gpio-list|。注意，烧录后，USB_SERIAL_JTAG 的 USB CDC 功能仍然可用，即仍然可以通过 USB CDC 进行烧录和 log 查看。 - - - 烧录 ``JTAG_SEL_ENABLE`` eFuse 后，JTAG 接口的选择将由 strapping 管脚 |jtag-sel-gpio| 来决定。{IDF_TARGET_NAME} 复位时，如果该 strapping 管脚为低电平，JTAG 接口将使用 |jtag-gpio-list|，如果为高电平，USB_SERIAL_JTAG 将被用作 JTAG 接口。 + .. warning:: + 请注意，烧录 eFuse 是一项不可逆的操作，请在开始前谨慎考虑以上选项。 +.. only:: esp32c3 + + 配置 eFuse + ^^^^^^^^^^^^^^^^ + + {IDF_TARGET_NAME} JTAG 接口默认连接至 :doc:`内置 USB_SERIAL_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:: + 请注意，烧录 eFuse 是一项不可逆的操作，请在开始前谨慎考虑以上选项。 + 配置硬件 ^^^^^^^^ @@ -45,4 +57,4 @@ 将 JTAG 接口连接到计算机，打开 {IDF_TARGET_NAME} 和 JTAG 接口板上的电源，然后检查计算机是否可以识别到 JTAG 接口。 -要继续设置调试环境，请前往 :ref:`jtag-debugging-run-openocd` 章节。 \ No newline at end of file +如需继续设置调试环境，请前往 :ref:`jtag-debugging-run-openocd` 章节。