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
2019-11-22 05:32:35 +08:00 · 2019-11-22 05:32:35 +08:00 · 8ff801766a
parent 38520d3b65 1626f827d3
commit 8ff801766a
12 changed files with 46 additions and 46 deletions
--- a/docs/en/api-guides/jtag-debugging/configure-wrover.rst
+++ b/docs/en/api-guides/jtag-debugging/configure-wrover.rst
@ -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::

--- a/docs/en/api-guides/jtag-debugging/index.rst
+++ b/docs/en/api-guides/jtag-debugging/index.rst
@ -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:
--- a/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst
+++ b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst
@ -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:

--- a/docs/en/api-guides/jtag-debugging/using-debugger.rst
+++ b/docs/en/api-guides/jtag-debugging/using-debugger.rst
@ -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. 

--- a/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst
+++ b/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst
@ -123,7 +123,7 @@ MacOS

 4. 运行 OpenOCD::

-    openocd -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
+    openocd -f board/esp32-wrover-kit-3.3v.cfg

 5. 在另一个终端窗口，再一次加载 FTDI 串口驱动::

--- a/docs/zh_CN/api-guides/jtag-debugging/index.rst
+++ b/docs/zh_CN/api-guides/jtag-debugging/index.rst
@ -140,7 +140,7 @@ JTAG 正常工作至少需要连接的信号线有：TDI，TDO，TCK，TMS 和 G

 打开终端，按照快速入门中的指南 :ref:`设置好开发环境 <get-started-set-up-env>` ，然后运行如下命令，启动 OpenOCD（该命令在 Windows，Linux，和 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::

@ -150,7 +150,7 @@ JTAG 正常工作至少需要连接的信号线有：TDI，TDO，TCK，TMS 和 G

 现在应该可以看到如下输入（此日志来自 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
@ -179,11 +179,11 @@ JTAG 正常工作至少需要连接的信号线有：TDI，TDO，TCK，TMS 和 G

 除此以外，还支持使用 OpenOCD 通过 JTAG 接口将应用程序镜像烧写到闪存中，命令如下::

-    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 的烧写命令 ``program_esp32`` 具有以下格式：
+其中 OpenOCD 的烧写命令 ``program_esp`` 具有以下格式：

-``program_esp32 <image_file> <offset> [verify] [reset] [exit]``
+``program_esp <image_file> <offset> [verify] [reset] [exit]``

    -  ``image_file`` - 程序镜像文件存放的路径
    -  ``offset`` - 镜像烧写到闪存中的偏移地址
@ -260,11 +260,11 @@ Windows 用户可以执行::

 运行本地编译的 OpenOCD 的示例如下（Linux 和 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

 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:
--- a/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst
+++ b/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst
@ -35,7 +35,7 @@ ESP32 调试器支持 2 个硬件断点和 64 个软件断点。硬件断点是

    由于 GDB 在连接 OpenOCD 时仅仅请求一次内存映射，所以可以在 TCL 配置文件中指定该命令，或者通过命令行传递给 OpenOCD。对于后者，命令行示例如下：

-    ``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 -c "init; halt; esp32 appimage_offset 0x210000"``

    另外还可以通过 OpenOCD 的 telnet 会话执行该命令，然后再连接 GDB， 不过这种方式似乎没有那么便捷。

@ -258,13 +258,13 @@ ESP32 的目标配置文件

        ::

-            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

        这种方式会将日志输出到文件，但是它会阻止调试信息打印在终端上。当有大量信息需要输出的时候（比如调试等级提高到 ``-d 3``）这是个不错的选择。如果你仍然希望在屏幕上看到调试日志，请改用以下命令：

        ::

-            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 端：

--- a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst
+++ b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst
@ -60,10 +60,10 @@
        如果你想在启动新的调试会话之前自动更新闪存中的镜像，请在 “Initialization Commands” 文本框的开头添加以下命令行::

            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


-    有关 ``program_esp32`` 命令的说明请参考 :ref:`jtag-upload-app-debug` 章节。
+    有关 ``program_esp`` 命令的说明请参考 :ref:`jtag-upload-app-debug` 章节。

 9.  在 “Load Image and Symbols” 下，取消选中 “Load image” 选项。

--- a/examples/protocols/http_server/restful_server/README.md
+++ b/examples/protocols/http_server/restful_server/README.md
@ -99,7 +99,7 @@ See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/l
 We need to run the latest version of OpenOCD which should support semihost feature when we test this deploy mode:

 ```bash
-openocd-esp32/bin/openocd -s openocd-esp32/share/openocd/scripts -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
+openocd-esp32/bin/openocd -s openocd-esp32/share/openocd/scripts -f board/esp32-wrover-kit-3.3v.cfg
 ```

 ## Example Output
--- a/examples/storage/semihost_vfs/README.md
+++ b/examples/storage/semihost_vfs/README.md
@ -21,7 +21,7 @@ NOTE: In order to run this example you need OpenOCD version `v0.10.0-esp32-20190

 Run OpenOCD using command:
 ```
-bin/openocd -s share/openocd/scripts -f interface/ftdi/esp32_devkitj_v1.cfg -c 'set ESP_SEMIHOST_BASEDIR '$IDF_PATH/examples/storage/semihost_vfs/data -f board/esp-wroom-32.cfg
+bin/openocd -s share/openocd/scripts -c 'set ESP_SEMIHOST_BASEDIR '$IDF_PATH/examples/storage/semihost_vfs/data -f board/esp32-wrover-kit-3.3v.cfg
 ```
 This command also configures OpenOCD to expose example project `data` subdirectory to the target's semihosting VFS driver.

--- a/examples/system/sysview_tracing/README.md
+++ b/examples/system/sysview_tracing/README.md
@ -94,7 +94,7 @@ To run the example and find out the reason of the problem:

    ```
    cd ~/esp/openocd-esp32
-    bin/openocd -s share/openocd/scripts -f interface/ftdi/esp32_devkitj_v1.cfg -f board/esp-wroom-32.cfg
+    bin/openocd -s share/openocd/scripts -f board/esp32-wrover-kit-3.3v.cfg
    ```
 NOTE: In order to run this example you need OpenOCD version `v0.10.0-esp32-20181105` or later.

--- a/tools/tools.json
+++ b/tools/tools.json
@ -263,31 +263,31 @@
      "versions": [
        {
          "linux-amd64": {
-            "sha256": "038affba6cb2874098f6b70e61ce139afdf056f926ea6aefcf4d90a6ccf05bc3",
-            "size": 1675213,
-            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20190708/openocd-esp32-linux64-0.10.0-esp32-20190708.tar.gz"
+            "sha256": "978213e8345dd19762c79d4bda309331bb78db3d2a7f7193641dfcc978f6e5e5",
+            "size": 1680363,
+            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20191114/openocd-esp32-linux64-0.10.0-esp32-20191114.tar.gz"
          },
          "linux-armel": {
-            "sha256": "f3f01d2b0ec440127b8951b82ee79dd04b9d2774bab4de741067c5f65cffaa7e",
-            "size": 1729130,
-            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20190708/openocd-esp32-armel-0.10.0-esp32-20190708.tar.gz"
+            "sha256": "3b41d889e54c03d26ebf4423084a1c25a9b0a8c5d93359a3eece1754377dbd81",
+            "size": 1730768,
+            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20191114/openocd-esp32-armel-0.10.0-esp32-20191114.tar.gz"
          },
          "macos": {
-            "sha256": "840c94ce6208c5b21d0ba6c3113a06405daf6b27085a287cfbb6c9d21e80bd70",
-            "size": 1760060,
-            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20190708/openocd-esp32-macos-0.10.0-esp32-20190708.tar.gz"
+            "sha256": "75ca2e235c35157d6dad2106cc62210ccb99b736da6940179aa1644fe1ae8c2b",
+            "size": 1765567,
+            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20191114/openocd-esp32-macos-0.10.0-esp32-20191114.tar.gz"
          },
-          "name": "v0.10.0-esp32-20190708",
+          "name": "v0.10.0-esp32-20191114",
          "status": "recommended",
          "win32": {
-            "sha256": "a3a6f288a501c2992d2950c1b2c502e479e16aedda21b626602933c75f027a13",
-            "size": 2098530,
-            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20190708/openocd-esp32-win32-0.10.0-esp32-20190708.zip"
+            "sha256": "698bfa5903c99e2ee0a1898379b3a40451fcecbc1fd4fde4f2f1494e5725e7ab",
+            "size": 2102699,
+            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20191114/openocd-esp32-win32-0.10.0-esp32-20191114.zip"
          },
          "win64": {
-            "sha256": "a3a6f288a501c2992d2950c1b2c502e479e16aedda21b626602933c75f027a13",
-            "size": 2098530,
-            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20190708/openocd-esp32-win32-0.10.0-esp32-20190708.zip"
+            "sha256": "698bfa5903c99e2ee0a1898379b3a40451fcecbc1fd4fde4f2f1494e5725e7ab",
+            "size": 2102699,
+            "url": "https://github.com/espressif/openocd-esp32/releases/download/v0.10.0-esp32-20191114/openocd-esp32-win32-0.10.0-esp32-20191114.zip"
          }
        }
      ]