docs: esp32: update openocd section
This PR removes information regarding previous west extension related to OpenOCD download. This extension is no longer available and manual download is required until upstream OpenOCD receives all xtensa and riscv patches. Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
This commit is contained in:
Sylvio Alves
Carles Cufí
parent
bf845a273b
commit
9105f1ef61
8 changed files with 28 additions and 108 deletions
|
|
@ -86,18 +86,9 @@ message in the monitor:
|
|||
Debugging
|
||||
---------
|
||||
|
||||
As with much custom hardware, the ESP32C3 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -124,3 +115,4 @@ References
|
|||
.. [1] https://www.espressif.com/en/products/socs/esp32-c3
|
||||
.. _`ESP32C3 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf
|
||||
.. _`ESP32C3 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
|
|
@ -96,17 +96,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -205,14 +196,6 @@ References
|
|||
.. [1] https://en.wikipedia.org/wiki/ESP32
|
||||
.. _`ESP32 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
|
||||
.. _`JTAG debugging for ESP32`: http://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html
|
||||
.. _`toolchain`: https://esp-idf.readthedocs.io/en/latest/get-started/index.html#get-started-setup-toochain
|
||||
.. _`SDK`: https://esp-idf.readthedocs.io/en/latest/get-started/index.html#get-started-get-esp-idf
|
||||
.. _`Hardware Reference`: https://esp-idf.readthedocs.io/en/latest/hw-reference/index.html
|
||||
.. _`esptool documentation`: https://github.com/espressif/esptool/blob/master/README.md
|
||||
.. _`esptool.py`: https://github.com/espressif/esptool
|
||||
.. _`ESP-WROVER-32 V3 Getting Started Guide`: https://dl.espressif.com/doc/esp-idf/latest/get-started/get-started-wrover-kit.html
|
||||
.. _`installing prerequisites`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-1-install-prerequisites
|
||||
.. _`set up the tools`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-3-set-up-the-tools
|
||||
.. _`set up environment variables`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-4-set-up-the-environment-variables
|
||||
.. _`ESP32 Toolchain`: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf
|
||||
.. _`OpenOCD for ESP32 download`: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#openocd-esp32
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
|
|
@ -65,17 +65,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -173,14 +164,6 @@ References
|
|||
|
||||
.. _`ESP32 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
|
||||
.. _`JTAG debugging for ESP32`: http://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html
|
||||
.. _`toolchain`: https://esp-idf.readthedocs.io/en/latest/get-started/index.html#get-started-setup-toochain
|
||||
.. _`SDK`: https://esp-idf.readthedocs.io/en/latest/get-started/index.html#get-started-get-esp-idf
|
||||
.. _`Hardware Reference`: https://esp-idf.readthedocs.io/en/latest/hw-reference/index.html
|
||||
.. _`esptool documentation`: https://github.com/espressif/esptool/blob/master/README.md
|
||||
.. _`esptool.py`: https://github.com/espressif/esptool
|
||||
.. _`ESP-WROVER-32 V3 Getting Started Guide`: https://dl.espressif.com/doc/esp-idf/latest/get-started/get-started-wrover-kit.html
|
||||
.. _`installing prerequisites`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-1-install-prerequisites
|
||||
.. _`set up the tools`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-3-set-up-the-tools
|
||||
.. _`set up environment variables`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-4-set-up-the-environment-variables
|
||||
.. _`ESP32 Toolchain`: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf
|
||||
.. _`OpenOCD for ESP32 download`: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#openocd-esp32
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
|
|
@ -84,18 +84,9 @@ message in the monitor:
|
|||
Debugging
|
||||
---------
|
||||
|
||||
As with much custom hardware, the ESP32S2 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -122,3 +113,4 @@ References
|
|||
.. [1] https://www.espressif.com/en/products/socs/esp32-s2
|
||||
.. _`ESP32S2 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
|
||||
.. _`ESP32S2 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
|
|
@ -494,17 +494,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -533,3 +524,4 @@ Related Documents
|
|||
- `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
- `ESP32-WROVER-E Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-e_esp32-wrover-ie_datasheet_en.pdf>`_ (PDF)
|
||||
- `ESP32 Hardware Reference <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/index.html>`_
|
||||
- `OpenOCD ESP32 <https://github.com/espressif/openocd-esp32/releases>`_
|
||||
|
|
|
|||
|
|
@ -77,17 +77,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -131,5 +122,6 @@ References
|
|||
- `Heltec WiFi LoRa (v2) Schematic Diagrams <https://resource.heltec.cn/download/WiFi_LoRa_32/V2>`_
|
||||
- `ESP32 Toolchain <https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf>`_
|
||||
- `esptool documentation <https://github.com/espressif/esptool/blob/master/README.md>`_
|
||||
- `OpenOCD ESP32 <https://github.com/espressif/openocd-esp32/releases>`_
|
||||
|
||||
.. [1] https://heltec.org/project/wifi-lora-32/
|
||||
|
|
|
|||
|
|
@ -133,17 +133,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -170,3 +161,4 @@ References
|
|||
.. target-notes::
|
||||
|
||||
.. [1] https://wiki.odroid.com/odroid_go/odroid_go
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
|
|
@ -143,17 +143,8 @@ Debugging
|
|||
---------
|
||||
|
||||
As with much custom hardware, the ESP32 modules require patches to
|
||||
OpenOCD that are not upstreamed. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained by running the following extension:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
west espressif install
|
||||
|
||||
.. note::
|
||||
|
||||
By default, the OpenOCD will be downloaded and installed under $HOME/.espressif/tools/zephyr directory
|
||||
(%USERPROFILE%/.espressif/tools/zephyr on Windows).
|
||||
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
|
||||
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
|
||||
|
||||
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
|
||||
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
|
||||
|
|
@ -185,3 +176,6 @@ You can debug an application in the usual way. Here is an example for the :ref:`
|
|||
|
||||
.. _ESP32-WROOM32-E/UE Datasheet:
|
||||
https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf
|
||||
|
||||
.. _OpenOCD ESP32:
|
||||
https://github.com/espressif/openocd-esp32/releases
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue