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

Merge branch 'doc_update_esp32p4_jtag' into 'master'

Browse Source 
Update esp32p4 jtag debugging guide

Closes IDF-7758

See merge request espressif/esp-idf!26527
This commit is contained in:
Erhan Kurubas 2024-04-13 02:10:21 +08:00
commit 72f463afc6
8 changed files with 67 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docs_not_updated/esp32p4.txt
View File

@ -2,17 +2,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/esp32p4.inc
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/partition-tables.rst
api-guides/app_trace.rst
api-guides/thread-local-storage.rst

2
docs/en/api-guides/jtag-debugging/configure-other-jtag.rst
View File

@ -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"}
{IDF_TARGET_JTAG_SEL_EFUSE:default="Not Updated!", esp32s3="STRAP_JTAG_SEL", esp32c6="JTAG_SEL_ENABLE", esp32h2="JTAG_SEL_ENABLE", esp32p4="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.

60
docs/en/api-guides/jtag-debugging/esp32p4.inc
View File

@ -13,7 +13,7 @@
openocd -f board/esp32p4-builtin.cfg
.. |run-openocd-device-name| replace:: ESP32-p4 through built-in USB connection
.. |run-openocd-device-name| replace:: ESP32-P4 through built-in USB connection
---
@ -22,27 +22,27 @@
::
user-name@computer-name:~/esp/esp-idf$ openocd -f board/esp32p4-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 (2024-03-18-18:25)
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)
adapter speed: 40000 kHz
Info : esp_usb_jtag: serial (60:55:F9:F8:80:5C)
Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
Info : clock speed 24000 kHz
Info : JTAG tap: esp32p4.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 esp32p4 on 3333
Info : JTAG tap: esp32p4.lp.cpu tap/device found: 0x00012c25 (mfg: 0x612 (Espressif Systems), part: 0x0012, ver: 0x0)
Info : JTAG tap: esp32p4.hp.cpu tap/device found: 0x00012c25 (mfg: 0x612 (Espressif Systems), part: 0x0012, ver: 0x0)
Info : [esp32p4.hp.cpu] datacount=1 progbufsize=2
Info : [esp32p4.hp.cpu] Examined RISC-V core; found 2 harts
Info : [esp32p4.hp.cpu] XLEN=32, misa=0x40901125
Info : [esp32p4.hp.cpu] Examination succeed
Info : starting gdb server for esp32p4.hp.cpu on 3333
Info : Listening on port 3333 for gdb connections
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32p4-builtin.cfg``
@ -88,21 +88,21 @@
.. openocd-cfg-files
.. list-table:: OpenOCD configuration files for ESP32-p4
.. list-table:: OpenOCD configuration files for ESP32-P4
:widths: 25 75
:header-rows: 1
* - Name
- Description
* - ``board/esp32p4-builtin.cfg``
- Board configuration file for ESP32-p4 through built-in USB, includes target and adapter configuration.
- Board configuration file for ESP32-P4 through built-in USB, includes target and adapter configuration.
* - ``board/esp32p4-ftdi.cfg``
- Board configuration file for ESP32-p4 for via externally connected FTDI-based probe like ESP-Prog, includes target and adapter configuration.
- Board configuration file for ESP32-P4 for via externally connected FTDI-based probe like ESP-Prog, includes target and adapter configuration.
* - ``target/esp32p4.cfg``
- ESP32-p4 target configuration file. Can be used together with one of the ``interface/`` configuration files.
- ESP32-P4 target configuration file. Can be used together with one of the ``interface/`` configuration files.
* - ``interface/esp_usb_jtag.cfg``
- JTAG adapter configuration file for ESP32-p4.
* - ``interface/ftdi/esp32_devkitj_v1.cfg``
- JTAG adapter configuration file for ESP32-P4.
* - ``interface/ftdi/esp32p4_ftdi.cfg``
- JTAG adapter configuration file for ESP-Prog boards.
---
@ -115,23 +115,23 @@
.. jtag-pins
.. list-table:: ESP32-p4 pins and JTAG signals
.. list-table:: ESP32-P4 pins and JTAG signals
:widths: 25 75
:header-rows: 1
* - ESP32-p4 Pin
* - ESP32-P4 Pin
- JTAG Signal
* - MTDO / GPIO7
* - MTDO / GPIO5
- TDO
* - MTDI / GPIO5
* - MTDI / GPIO3
- TDI
* - MTCK / GPIO6
* - MTCK / GPIO2
- TCK
* - MTMS / GPIO4
- TMS
.. |jtag-sel-gpio| replace:: GPIO15
.. |jtag-gpio-list| replace:: GPIO4-GPIO7
.. |jtag-sel-gpio| replace:: GPIO34
.. |jtag-gpio-list| replace:: GPIO2-GPIO5
---
@ -161,13 +161,13 @@
.. devkit-defs
.. |devkit-name| replace:: ESP32-p4
.. |devkit-name-with-link| replace:: :doc:`ESP32-p4 <../../hw-reference/index>`
.. |devkit-name| replace:: ESP32-P4
.. |devkit-name-with-link| replace:: :doc:`ESP32-P4 <../../hw-reference/index>`
---
.. devkit-hw-config
* Out of the box, ESP32-p4 doesn't need any additional hardware configuration for JTAG debugging.
* Out of the box, ESP32-P4 doesn't need any additional hardware configuration for JTAG debugging.
---

4
docs/en/api-guides/jtag-debugging/index.rst
View File

@ -125,10 +125,10 @@ If you have already set up ESP-IDF with CMake build system according to the :doc
The output should be as follows (although the version may be more recent than listed here)::
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
Open On-Chip Debugger v0.12.0-esp32-20240318 (2024-03-18-18:25)
Licensed under GNU GPL v2
For bug reports, read
https://openocd.org/doc/doxygen/bugs.html
http://openocd.org/doc/doxygen/bugs.html
You may also verify that OpenOCD knows where its configuration scripts are located by printing the value of ``OPENOCD_SCRIPTS`` environment variable, by typing ``echo $OPENOCD_SCRIPTS`` (for Linux and macOS) or ``echo %OPENOCD_SCRIPTS%`` (for Windows). If a valid path is printed, then OpenOCD is set up correctly.

2
docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst
View File

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

60
docs/zh_CN/api-guides/jtag-debugging/esp32p4.inc
View File

@ -13,7 +13,7 @@
openocd -f board/esp32p4-builtin.cfg
.. |run-openocd-device-name| replace:: ESP32-p4 through built-in USB connection
.. |run-openocd-device-name| replace:: ESP32-P4 through built-in USB connection
---
@ -22,27 +22,27 @@
::
user-name@computer-name:~/esp/esp-idf$ openocd -f board/esp32p4-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 (2024-03-18-18:25)
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)
adapter speed: 40000 kHz
Info : esp_usb_jtag: serial (60:55:F9:F8:80:5C)
Info : esp_usb_jtag: Device found. Base speed 24000KHz, div range 1 to 255
Info : clock speed 24000 kHz
Info : JTAG tap: esp32p4.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 esp32p4 on 3333
Info : JTAG tap: esp32p4.lp.cpu tap/device found: 0x00012c25 (mfg: 0x612 (Espressif Systems), part: 0x0012, ver: 0x0)
Info : JTAG tap: esp32p4.hp.cpu tap/device found: 0x00012c25 (mfg: 0x612 (Espressif Systems), part: 0x0012, ver: 0x0)
Info : [esp32p4.hp.cpu] datacount=1 progbufsize=2
Info : [esp32p4.hp.cpu] Examined RISC-V core; found 2 harts
Info : [esp32p4.hp.cpu] XLEN=32, misa=0x40901125
Info : [esp32p4.hp.cpu] Examination succeed
Info : starting gdb server for esp32p4.hp.cpu on 3333
Info : Listening on port 3333 for gdb connections
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32p4-builtin.cfg``
@ -88,21 +88,21 @@
.. openocd-cfg-files
.. list-table:: OpenOCD configuration files for ESP32-p4
.. list-table:: OpenOCD configuration files for ESP32-P4
:widths: 25 75
:header-rows: 1
* - Name
- Description
* - ``board/esp32p4-builtin.cfg``
- Board configuration file for ESP32-p4 through built-in USB, includes target and adapter configuration.
- Board configuration file for ESP32-P4 through built-in USB, includes target and adapter configuration.
* - ``board/esp32p4-ftdi.cfg``
- Board configuration file for ESP32-p4 for via externally connected FTDI-based probe like ESP-Prog, includes target and adapter configuration.
- Board configuration file for ESP32-P4 for via externally connected FTDI-based probe like ESP-Prog, includes target and adapter configuration.
* - ``target/esp32p4.cfg``
- ESP32-p4 target configuration file. Can be used together with one of the ``interface/`` configuration files.
- ESP32-P4 target configuration file. Can be used together with one of the ``interface/`` configuration files.
* - ``interface/esp_usb_jtag.cfg``
- JTAG adapter configuration file for ESP32-p4.
* - ``interface/ftdi/esp32_devkitj_v1.cfg``
- JTAG adapter configuration file for ESP32-P4.
* - ``interface/ftdi/esp32p4_ftdi.cfg``
- JTAG adapter configuration file for ESP-Prog boards.
---
@ -115,23 +115,23 @@
.. jtag-pins
.. list-table:: ESP32-p4 pins and JTAG signals
.. list-table:: ESP32-P4 pins and JTAG signals
:widths: 25 75
:header-rows: 1
* - ESP32-p4 Pin
* - ESP32-P4 Pin
- JTAG Signal
* - MTDO / GPIO7
* - MTDO / GPIO5
- TDO
* - MTDI / GPIO5
* - MTDI / GPIO3
- TDI
* - MTCK / GPIO6
* - MTCK / GPIO2
- TCK
* - MTMS / GPIO4
- TMS
.. |jtag-sel-gpio| replace:: GPIO15
.. |jtag-gpio-list| replace:: GPIO4-GPIO7
.. |jtag-sel-gpio| replace:: GPIO34
.. |jtag-gpio-list| replace:: GPIO2-GPIO5
---
@ -161,13 +161,13 @@
.. devkit-defs
.. |devkit-name| replace:: ESP32-p4
.. |devkit-name-with-link| replace:: :doc:`ESP32-p4 <../../hw-reference/index>`
.. |devkit-name| replace:: ESP32-P4
.. |devkit-name-with-link| replace:: :doc:`ESP32-P4 <../../hw-reference/index>`
---
.. devkit-hw-config
* Out of the box, ESP32-p4 doesn't need any additional hardware configuration for JTAG debugging.
* Out of the box, ESP32-P4 doesn't need any additional hardware configuration for JTAG debugging.
---

4
docs/zh_CN/api-guides/jtag-debugging/index.rst
View File

@ -125,10 +125,10 @@ JTAG 调试
终端会输出以下信息（实际版本号可能会更新）::
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
Open On-Chip Debugger v0.12.0-esp32-20240318 (2024-03-18-18:25)
Licensed under GNU GPL v2
For bug reports, read
https://openocd.org/doc/doxygen/bugs.html
http://openocd.org/doc/doxygen/bugs.html
你还可以检查 ``OPENOCD_SCRIPTS`` 环境变量的值，以确认 OpenOCD 配置文件的路径，Linux 和 macOS 用户可以在终端输入 ``echo $OPENOCD_SCRIPTS``，Windows 用户需要输入 ``echo %OPENOCD_SCRIPTS%``。如果终端输出了有效路径，则表明已经正确安装 OpenOCD。

1
tools/idf_py_actions/constants.py
View File

@ -45,4 +45,5 @@ OPENOCD_TAGET_CONFIG: Dict[str, str] = {
'esp32c6': '-f board/esp32c6-builtin.cfg',
'esp32c5': '-f board/esp32c5-builtin.cfg',
'esp32h2': '-f board/esp32h2-builtin.cfg',
'esp32p4': '-f board/esp32p4-builtin.cfg',
}