diff --git a/Documentation/platforms/risc-v/esp32c3/index.rst b/Documentation/platforms/risc-v/esp32c3/index.rst index 66334e8c04..8158b2bfd2 100644 --- a/Documentation/platforms/risc-v/esp32c3/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/index.rst @@ -209,7 +209,13 @@ GND Ground OpenOCD can then be used:: - openocd -c 'set ESP_RTOS hwthread; set ESP_FLASH_SIZE 0' -f board/esp32c3-builtin.cfg + openocd -s -c 'set ESP_RTOS hwthread' -f board/esp32c3-builtin.cfg -c 'init; reset halt; esp appimage_offset 0x0' + +.. note:: + - ``appimage_offset`` should be set to ``0x0`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESPRESSIF_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. If you want to debug with an external JTAG adapter it can be connected as follows: diff --git a/Documentation/platforms/risc-v/esp32c6/index.rst b/Documentation/platforms/risc-v/esp32c6/index.rst index ae9f896b4b..c72fc77994 100644 --- a/Documentation/platforms/risc-v/esp32c6/index.rst +++ b/Documentation/platforms/risc-v/esp32c6/index.rst @@ -200,7 +200,13 @@ USB-to-JTAG adapter. OpenOCD can then be used:: - openocd -c 'set ESP_RTOS hwthread; set ESP_FLASH_SIZE 0' -f board/esp32c6-builtin.cfg + openocd -s -c 'set ESP_RTOS hwthread' -f board/esp32c3-builtin.cfg -c 'init; reset halt; esp appimage_offset 0x0' + +.. note:: + - ``appimage_offset`` should be set to ``0x0`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESPRESSIF_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. If you want to debug with an external JTAG adapter it can be connected as follows: diff --git a/Documentation/platforms/risc-v/esp32h2/index.rst b/Documentation/platforms/risc-v/esp32h2/index.rst index a6ef8c6e8a..2e0fba3353 100644 --- a/Documentation/platforms/risc-v/esp32h2/index.rst +++ b/Documentation/platforms/risc-v/esp32h2/index.rst @@ -201,7 +201,13 @@ USB-to-JTAG adapter. OpenOCD can then be used:: - openocd -c 'set ESP_RTOS hwthread; set ESP_FLASH_SIZE 0' -f board/esp32h2-builtin.cfg + openocd -s -c 'set ESP_RTOS hwthread' -f board/esp32c3-builtin.cfg -c 'init; reset halt; esp appimage_offset 0x0' + +.. note:: + - ``appimage_offset`` should be set to ``0x0`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESPRESSIF_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. If you want to debug with an external JTAG adapter it can be connected as follows: diff --git a/Documentation/platforms/xtensa/esp32/index.rst b/Documentation/platforms/xtensa/esp32/index.rst index 8d350f59b2..534cb9de66 100644 --- a/Documentation/platforms/xtensa/esp32/index.rst +++ b/Documentation/platforms/xtensa/esp32/index.rst @@ -241,7 +241,13 @@ described for the :ref:`ESP32-DevKitC -c 'set ESP_RTOS hwthread' -f board/esp32-wrover-kit-3.3v.cfg -c 'init; reset halt; esp appimage_offset 0x1000' + +.. note:: + - ``appimage_offset`` should be set to ``0x1000`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESP32_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. Once OpenOCD is running, you can use GDB to connect to it and debug your application:: diff --git a/Documentation/platforms/xtensa/esp32s2/index.rst b/Documentation/platforms/xtensa/esp32s2/index.rst index 988d6c6324..48023168dd 100644 --- a/Documentation/platforms/xtensa/esp32s2/index.rst +++ b/Documentation/platforms/xtensa/esp32s2/index.rst @@ -231,7 +231,13 @@ directly to the ESP32-S2 JTAG pins. OpenOCD can then be used:: - openocd -c 'set ESP_RTOS hwthread; set ESP_FLASH_SIZE 0' -f board/esp32s2-kaluga-1.cfg + openocd -s -c 'set ESP_RTOS hwthread' -f board/esp32s2-kaluga-1.cfg -c 'init; reset halt; esp appimage_offset 0x1000' + +.. note:: + - ``appimage_offset`` should be set to ``0x1000`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESPRESSIF_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. Once OpenOCD is running, you can use GDB to connect to it and debug your application:: diff --git a/Documentation/platforms/xtensa/esp32s3/index.rst b/Documentation/platforms/xtensa/esp32s3/index.rst index caadcf6f51..cf397a261a 100644 --- a/Documentation/platforms/xtensa/esp32s3/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/index.rst @@ -227,7 +227,13 @@ This is the case for the :ref:`ESP32-S3-DevKit -c 'set ESP_RTOS hwthread' -f board/esp32s3-builtin.cfg -c 'init; reset halt; esp appimage_offset 0x0' + +.. note:: + - ``appimage_offset`` should be set to ``0x0`` when ``Simple Boot`` is used. For MCUboot, this value should be set to + ``CONFIG_ESP32S3_OTA_PRIMARY_SLOT_OFFSET`` value (``0x10000`` by default). + - ``-s `` defines the path to the OpenOCD scripts. Usually set to `tcl` if running openocd from its source directory. + It can be omitted if `openocd-esp32` were installed in the system with `sudo make install`. Once OpenOCD is running, you can use GDB to connect to it and debug your application::