docs(jtag): update esp32c61 jtag debugging guide

2024-09-14 12:17:38 +03:00 · 2024-09-14 12:17:38 +03:00 · 6ade64eb05
commit 6ade64eb05
--- a/docs/docs_not_updated/esp32c61.txt
+++ b/docs/docs_not_updated/esp32c61.txt
@ -3,16 +3,6 @@ api-guides/performance/speed.rst
 api-guides/performance/size.rst
 api-guides/performance/ram-usage.rst
 api-guides/performance/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/phy.rst
 api-guides/app_trace.rst
 api-guides/low-power-mode.rst
--- 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", esp32c5="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", esp32c61="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.

--- a/docs/en/api-guides/jtag-debugging/esp32c61.inc
+++ b/docs/en/api-guides/jtag-debugging/esp32c61.inc
@ -37,11 +37,12 @@
    Info : esp_usb_jtag: serial (60:55:F9:F6:03:3C)
    Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
    Info : clock speed 24000 kHz
-    Info : JTAG tap: esp32c61.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 esp32c61 on 3333
+    Info : JTAG tap: esp32c61.tap0 tap/device found: 0x00014c25 (mfg: 0x612 (Espressif Systems), part: 0x0014, ver: 0x0)
+    Info : [esp32c61] datacount=1 progbufsize=2
+    Info : [esp32c61] Examined RISC-V core; found 1 harts
+    Info : [esp32c61]  XLEN=32, misa=0x40101105
+    Info : [esp32c61] Examination succeed
+    Info : [esp32c61] starting gdb server on 3333
    Info : Listening on port 3333 for gdb connections

 .. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c61-builtin.cfg``
@ -121,17 +122,17 @@

    * - ESP32-C61 Pin
      - JTAG Signal
-    * - MTDO / GPIO7
+    * - MTDO / GPIO6
      - TDO
-    * - MTDI / GPIO5
+    * - MTDI / GPIO4
      - TDI
-    * - MTCK / GPIO6
+    * - MTCK / GPIO5
      - TCK
-    * - MTMS / GPIO4
+    * - MTMS / GPIO3
      - TMS

-.. |jtag-sel-gpio| replace:: GPIO15
-.. |jtag-gpio-list| replace:: GPIO4-GPIO7
+.. |jtag-sel-gpio| replace:: GPIO7
+.. |jtag-gpio-list| replace:: GPIO3-GPIO6

 ---

--- 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", esp32p4="board/esp32p4-ftdi.cfg", esp32c5="board/esp32c5-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", esp32c61="board/esp32c61-ftdi.cfg"}

 .. note::

--- 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", esp32c5="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", esp32c61="JTAG_SEL_ENABLE"}

 关于适配 OpenOCD 和 {IDF_TARGET_NAME} 的 JTAG 接口选择问题，请参考 :ref:`jtag-debugging-selecting-jtag-adapter` 章节。然后按照以下步骤进行设置，使其正常工作。

--- a/docs/zh_CN/api-guides/jtag-debugging/esp32c61.inc
+++ b/docs/zh_CN/api-guides/jtag-debugging/esp32c61.inc
@ -37,11 +37,12 @@
    Info : esp_usb_jtag: serial (60:55:F9:F6:03:3C)
    Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
    Info : clock speed 24000 kHz
-    Info : JTAG tap: esp32c61.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 esp32c61 on 3333
+    Info : JTAG tap: esp32c61.tap0 tap/device found: 0x00014c25 (mfg: 0x612 (Espressif Systems), part: 0x0014, ver: 0x0)
+    Info : [esp32c61] datacount=1 progbufsize=2
+    Info : [esp32c61] Examined RISC-V core; found 1 harts
+    Info : [esp32c61]  XLEN=32, misa=0x40101105
+    Info : [esp32c61] Examination succeed
+    Info : [esp32c61] starting gdb server on 3333
    Info : Listening on port 3333 for gdb connections

 .. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c61-builtin.cfg``
--- 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", esp32p4="board/esp32p4-ftdi.cfg", esp32c5="board/esp32c5-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", esp32c61="board/esp32c61-ftdi.cfg"}

 .. note::

--- a/tools/idf_py_actions/constants.py
+++ b/tools/idf_py_actions/constants.py
@ -43,6 +43,7 @@ OPENOCD_TAGET_CONFIG: Dict[str, str] = {
    'esp32c3': '-f board/esp32c3-builtin.cfg',
    'esp32s3': '-f board/esp32s3-builtin.cfg',
    'esp32c6': '-f board/esp32c6-builtin.cfg',
+    'esp32c61': '-f board/esp32c61-builtin.cfg',
    'esp32c5': '-f board/esp32c5-builtin.cfg',
    'esp32h2': '-f board/esp32h2-builtin.cfg',
    'esp32p4': '-f board/esp32p4-builtin.cfg',