Merge branch 'esp32c5_jtag_doc_update' into 'master'

Update esp32c5 jtag debugging guide Closes IDF-9491 See merge request espressif/esp-idf!32189
liunix61 · Jul 23, 2024 · bdb9f97 · bdb9f97
2 parents e3925f4 + 07da0f6
commit bdb9f97
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 44 deletions.
diff --git a/docs/docs_not_updated/esp32c5.txt b/docs/docs_not_updated/esp32c5.txt
@@ -6,16 +6,6 @@ contribute/style-guide.rst
 contribute/copyright-guide.rst
 contribute/install-pre-commit-hook.rst
 contribute/index.rst
-api-guides/jtag-debugging/debugging-examples.rst
-api-guides/jtag-debugging/configure-ft2232h-jtag.rst
-api-guides/jtag-debugging/tips-and-quirks.rst
-api-guides/jtag-debugging/using-debugger.rst
-api-guides/jtag-debugging/building-openocd-macos.rst
-api-guides/jtag-debugging/building-openocd-linux.rst
-api-guides/jtag-debugging/configure-other-jtag.rst
-api-guides/jtag-debugging/building-openocd-windows.rst
-api-guides/jtag-debugging/index.rst
-api-guides/jtag-debugging/configure-builtin-jtag.rst
 api-guides/tools/idf-tools.rst
 api-guides/tools/idf-clang-tidy.rst
 api-guides/tools/idf-component-manager.rst

diff --git a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst
@@ -3,7 +3,7 @@ Configure Other JTAG Interfaces
 
 :link_to_translation:`zh_CN:[中文]`
 
-{IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE", esp32h2="JTAG_SEL_ENABLE", esp32p4="JTAG_SEL_ENABLE"}
+{IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE", esp32h2="JTAG_SEL_ENABLE", esp32p4="JTAG_SEL_ENABLE", esp32c5="JTAG_SEL_ENABLE"}
 
 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.
 

diff --git a/docs/en/api-guides/jtag-debugging/esp32c5.inc b/docs/en/api-guides/jtag-debugging/esp32c5.inc
@@ -22,26 +22,27 @@
 ::
 
     user-name@computer-name:~/esp/esp-idf$ openocd -f board/esp32c5-builtin.cfg
-    Open On-Chip Debugger v0.11.0-esp32-20221026-85-g0718fffd (2023-01-12-07:28)
+    Open On-Chip Debugger v0.12.0-esp32-20240318-139-g35ddcf93-dirty (2024-07-16-15:00)
     Licensed under GNU GPL v2
     For bug reports, read
             http://openocd.org/doc/doxygen/bugs.html
-    Info : only one transport option; autoselect 'jtag'
+    Info : only one transport option; autoselecting 'jtag'
     Info : esp_usb_jtag: VID set to 0x303a and PID to 0x1001
     Info : esp_usb_jtag: capabilities descriptor set to 0x2000
-    Warn : Transport "jtag" was already selected
     WARNING: ESP flash support is disabled!
     force hard breakpoints
     Info : Listening on port 6666 for tcl connections
     Info : Listening on port 4444 for telnet connections
-    Info : esp_usb_jtag: serial (60:55:F9:F6:03:3C)
+    Info : esp_usb_jtag: serial (60:55:F9:FF:FE:F9:54:A4)
     Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
     Info : clock speed 24000 kHz
-    Info : JTAG tap: esp32c5.cpu tap/device found: 0x0000dc25 (mfg: 0x612 (Espressif Systems), part: 0x000d, ver: 0x0)
-    Info : datacount=2 progbufsize=16
-    Info : Examined RISC-V core; found 2 harts
-    Info :  hart 0: XLEN=32, misa=0x40903105
-    Info : starting gdb server for esp32c5 on 3333
+    Info : JTAG tap: esp32c5.cpu0 tap/device found: 0x00017c25 (mfg: 0x612 (Espressif Systems), part: 0x0017, ver: 0x0)
+    Info : JTAG tap: esp32c5.cpu1 tap/device found: 0x00017c25 (mfg: 0x612 (Espressif Systems), part: 0x0017, ver: 0x0)
+    Info : [esp32c5.cpu1] datacount=1 progbufsize=2
+    Info : [esp32c5.cpu1] Examined RISC-V core; found 1 harts
+    Info : [esp32c5.cpu1]  XLEN=32, misa=0x40101105
+    Info : [esp32c5.cpu1] Examination succeed
+    Info : [esp32c5.cpu1] starting gdb server on 3333
     Info : Listening on port 3333 for gdb connections
 
 .. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c5-builtin.cfg``
@@ -121,17 +122,17 @@
 
     * - ESP32-C5 Pin
       - JTAG Signal
-    * - MTDO / GPIO7
+    * - MTDO / GPIO5
       - TDO
-    * - MTDI / GPIO5
+    * - MTDI / GPIO3
       - TDI
-    * - MTCK / GPIO6
+    * - MTCK / GPIO4
       - TCK
-    * - MTMS / GPIO4
+    * - MTMS / GPIO2
       - TMS
 
-.. |jtag-sel-gpio| replace:: GPIO15
-.. |jtag-gpio-list| replace:: GPIO4-GPIO7
+.. |jtag-sel-gpio| replace:: GPIO7
+.. |jtag-gpio-list| replace:: GPIO2-GPIO5
 
 ---
 

diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst
@@ -180,7 +180,7 @@ Open a terminal and set it up for using the ESP-IDF as described in the :ref:`se
    :start-after: run-openocd
    :end-before: ---
 
-{IDF_TARGET_FTDI_CONFIG:default="Not Updated!", esp32s3="board/esp32s3-ftdi.cfg", esp32c3="board/esp32c3-ftdi.cfg", esp32c6="board/esp32c6-ftdi.cfg", esp32h2="board/esp32h2-ftdi.cfg"}
+{IDF_TARGET_FTDI_CONFIG:default="Not Updated!", esp32s3="board/esp32s3-ftdi.cfg", esp32c3="board/esp32c3-ftdi.cfg", esp32c6="board/esp32c6-ftdi.cfg", esp32h2="board/esp32h2-ftdi.cfg", esp32p4="board/esp32p4-ftdi.cfg", esp32c5="board/esp32c5-ftdi.cfg"}
 
 .. note::
 

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
@@ -3,7 +3,7 @@
 
 :link_to_translation:`en:[English]`
 
-{IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE", esp32h2="JTAG_SEL_ENABLE", esp32p4="JTAG_SEL_ENABLE"}
+{IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE", esp32h2="JTAG_SEL_ENABLE", esp32p4="JTAG_SEL_ENABLE", esp32c5="JTAG_SEL_ENABLE"}
 
 关于适配 OpenOCD 和 {IDF_TARGET_NAME} 的 JTAG 接口选择问题，请参考 :ref:`jtag-debugging-selecting-jtag-adapter` 章节。然后按照以下步骤进行设置，使其正常工作。
 

diff --git a/docs/zh_CN/api-guides/jtag-debugging/esp32c5.inc b/docs/zh_CN/api-guides/jtag-debugging/esp32c5.inc
@@ -22,26 +22,27 @@
 ::
 
     user-name@computer-name:~/esp/esp-idf$ openocd -f board/esp32c5-builtin.cfg
-    Open On-Chip Debugger v0.11.0-esp32-20221026-85-g0718fffd (2023-01-12-07:28)
+    Open On-Chip Debugger v0.12.0-esp32-20240318-139-g35ddcf93-dirty (2024-07-16-15:00)
     Licensed under GNU GPL v2
     For bug reports, read
             http://openocd.org/doc/doxygen/bugs.html
-    Info : only one transport option; autoselect 'jtag'
+    Info : only one transport option; autoselecting 'jtag'
     Info : esp_usb_jtag: VID set to 0x303a and PID to 0x1001
     Info : esp_usb_jtag: capabilities descriptor set to 0x2000
-    Warn : Transport "jtag" was already selected
     WARNING: ESP flash support is disabled!
     force hard breakpoints
     Info : Listening on port 6666 for tcl connections
     Info : Listening on port 4444 for telnet connections
-    Info : esp_usb_jtag: serial (60:55:F9:F6:03:3C)
+    Info : esp_usb_jtag: serial (60:55:F9:FF:FE:F9:54:A4)
     Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
     Info : clock speed 24000 kHz
-    Info : JTAG tap: esp32c5.cpu tap/device found: 0x0000dc25 (mfg: 0x612 (Espressif Systems), part: 0x000d, ver: 0x0)
-    Info : datacount=2 progbufsize=16
-    Info : Examined RISC-V core; found 2 harts
-    Info :  hart 0: XLEN=32, misa=0x40903105
-    Info : starting gdb server for esp32c5 on 3333
+    Info : JTAG tap: esp32c5.cpu0 tap/device found: 0x00017c25 (mfg: 0x612 (Espressif Systems), part: 0x0017, ver: 0x0)
+    Info : JTAG tap: esp32c5.cpu1 tap/device found: 0x00017c25 (mfg: 0x612 (Espressif Systems), part: 0x0017, ver: 0x0)
+    Info : [esp32c5.cpu1] datacount=1 progbufsize=2
+    Info : [esp32c5.cpu1] Examined RISC-V core; found 1 harts
+    Info : [esp32c5.cpu1]  XLEN=32, misa=0x40101105
+    Info : [esp32c5.cpu1] Examination succeed
+    Info : [esp32c5.cpu1] starting gdb server on 3333
     Info : Listening on port 3333 for gdb connections
 
 .. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c5-builtin.cfg``
@@ -121,17 +122,17 @@
 
     * - ESP32-C5 Pin
       - JTAG Signal
-    * - MTDO / GPIO7
+    * - MTDO / GPIO5
       - TDO
-    * - MTDI / GPIO5
+    * - MTDI / GPIO3
       - TDI
-    * - MTCK / GPIO6
+    * - MTCK / GPIO4
       - TCK
-    * - MTMS / GPIO4
+    * - MTMS / GPIO2
       - TMS
 
-.. |jtag-sel-gpio| replace:: GPIO15
-.. |jtag-gpio-list| replace:: GPIO4-GPIO7
+.. |jtag-sel-gpio| replace:: GPIO7
+.. |jtag-gpio-list| replace:: GPIO2-GPIO5
 
 ---
 

diff --git a/docs/zh_CN/api-guides/jtag-debugging/index.rst b/docs/zh_CN/api-guides/jtag-debugging/index.rst
@@ -180,7 +180,7 @@ OpenOCD 安装完成后就可以配置 {IDF_TARGET_NAME} 目标（即带 JTAG
     :start-after: run-openocd
     :end-before: ---
 
-{IDF_TARGET_FTDI_CONFIG:default="Not Updated!", esp32s3="board/esp32s3-ftdi.cfg", esp32c3="board/esp32c3-ftdi.cfg", esp32c6="board/esp32c6-ftdi.cfg", esp32h2="board/esp32h2-ftdi.cfg"}
+{IDF_TARGET_FTDI_CONFIG:default="Not Updated!", esp32s3="board/esp32s3-ftdi.cfg", esp32c3="board/esp32c3-ftdi.cfg", esp32c6="board/esp32c6-ftdi.cfg", esp32h2="board/esp32h2-ftdi.cfg", esp32p4="board/esp32p4-ftdi.cfg", esp32c5="board/esp32c5-ftdi.cfg"}
 
 .. note::