Merge branch 'docs/update_oocd_config_on_cmd_line' into 'master'

Updates OpenOCD configuration file names in documentation

See merge request espressif/esp-idf!6226
This commit is contained in:
Ivan Grokhotkov
2019-11-22 05:32:35 +08:00
12 changed files with 46 additions and 46 deletions

View File

@@ -123,7 +123,7 @@ Manually unloading the driver
4. Run OpenOCD::
bin/openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
bin/openocd -f board/esp32-wrover-kit-3.3v.cfg
5. In another terminal window, load FTDI serial port driver again::

View File

@@ -142,7 +142,7 @@ Once target is configured and connected to computer, you are ready to launch Ope
Open a terminal and set it up for using the ESP-IDF as described in the :ref:`setting up the environment <get-started-set-up-env>` section of the Getting Started Guide. Then run OpenOCD (this command works on Windows, Linux, and macOS)::
openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
openocd -f board/esp32-wrover-kit-3.3v.cfg
.. note::
@@ -152,7 +152,7 @@ Open a terminal and set it up for using the ESP-IDF as described in the :ref:`se
You should now see similar output (this log is for ESP-WROVER-KIT)::
user-name@computer-name:~/esp/esp-idf$ openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
user-name@computer-name:~/esp/esp-idf$ openocd -f board/esp32-wrover-kit-3.3v.cfg
Open On-Chip Debugger v0.10.0-esp32-20190708 (2019-07-08-11:04)
Licensed under GNU GPL v2
For bug reports, read
@@ -168,7 +168,7 @@ You should now see similar output (this log is for ESP-WROVER-KIT)::
Info : esp32: Core was reset (pwrstat=0x5F, after clear 0x0F).
* If there is an error indicating permission problems, please see the "Permissions delegation" bit in the OpenOCD README file in ``~/esp/openocd-esp32`` directory.
* In case there is an error finding configuration files, e.g. ``Can't find interface/ftdi/esp32_devkitj_v1.cfg``, check the path after ``-s``. This path is used by OpenOCD to look for the files specified after ``-f``. Also check if the file is indeed under provided path.
* In case there is an error finding configuration files, e.g. ``Can't find board/esp32-wrover-kit-3.3v.cfg``, check the path after ``-s``. This path is used by OpenOCD to look for the files specified after ``-f``. Also check if the file is indeed under provided path.
* If you see JTAG errors (...all ones/...all zeroes) please check your connections, whether no other signals are connected to JTAG besides ESP32's pins, and see if everything is powered on.
@@ -181,11 +181,11 @@ Build and upload your application to ESP32 as usual, see :ref:`get-started-build
Another option is to write application image to flash using OpenOCD via JTAG with commands like this::
openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg -c "program_esp32 filename.bin 0x10000 verify exit"
openocd -f board/esp32-wrover-kit-3.3v.cfg -c "program_esp filename.bin 0x10000 verify exit"
OpenOCD flashing command ``program_esp32`` has the following format:
OpenOCD flashing command ``program_esp`` has the following format:
``program_esp32 <image_file> <offset> [verify] [reset] [exit]``
``program_esp <image_file> <offset> [verify] [reset] [exit]``
- ``image_file`` - Path to program image file.
- ``offset`` - Offset in flash bank to write image.
@@ -261,11 +261,11 @@ For Windows::
Example of invoking OpenOCD build locally from sources, for Linux and macOS::
src/openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
src/openocd -f board/esp32-wrover-kit-3.3v.cfg
and Windows::
src\openocd -f interface\ftdi\esp32_devkitj_v1.cfg -f board\esp-wroom-32.cfg
src\openocd -f board\esp32-wrover-kit-3.3v.cfg
.. _jtag-debugging-tips-and-quirks:

View File

@@ -36,7 +36,7 @@ Offset should be in hex format. To reset to the default behaviour you can specif
Since GDB requests memory map from OpenOCD only once when connecting to it, this command should be specified in one of the TCL configuration files, or passed to OpenOCD via its command line. In the latter case command line should look like below:
``openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg -c "init; halt; esp32 appimage_offset 0x210000"``
``openocd -f board/esp32-wrover-kit-3.3v.cfg.cfg -c "init; halt; esp32 appimage_offset 0x210000"``
Another option is to execute that command via OpenOCD telnet session and then connect GDB, but it seems to be less handy.
@@ -269,13 +269,13 @@ In case you encounter a problem with OpenOCD or GDB programs itself and do not f
::
openocd -l openocd_log.txt -d 3 -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
openocd -l openocd_log.txt -d 3 -f board/esp32-wrover-kit-3.3v.cfg
Logging to a file this way will prevent information displayed on the terminal. This may be a good thing taken amount of information provided, when increased debug level ``-d 3`` is set. If you still like to see the log on the screen, then use another command instead:
::
openocd -d 3 -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg 2>&1 | tee openocd.log
openocd -d 3 -f board/esp32-wrover-kit-3.3v.cfg 2>&1 | tee openocd.log
Debugger:

View File

@@ -61,9 +61,9 @@ Once installation is complete, configure debugging session following steps below
If you want to update image in the flash automatically before starting new debug session add the following lines of commands at the beginning of "Initialization Commands" textbox::
mon reset halt
mon program_esp32 ${workspace_loc:blink/build/blink.bin} 0x10000 verify
mon program_esp ${workspace_loc:blink/build/blink.bin} 0x10000 verify
For description of ``program_esp32`` command see :ref:`jtag-upload-app-debug`.
For description of ``program_esp`` command see :ref:`jtag-upload-app-debug`.
9. Under "Load Image and Symbols" uncheck "Load image" option.