espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-11 00:24:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Simplify OpenOCD udev rules instructions for manual Linux installation

Browse Source 
Instead of pointing the user to the OpenOCD documentation, we simply instruct them to copy a single file and point them directly to it.
This commit is contained in:
Djordje Nedic
2023-03-06 14:46:27 +01:00
parent 05037957c7
commit 29e8025750
3 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -37,3 +37,5 @@ Configure USB Drivers
JTAG communication should work on all supported platforms. Windows users might get `LIBUSB_ERROR_NOT_FOUND` errors. Please use version 2.8 (or newer) of the :ref:`get-started-windows-tools-installer` and select the driver "Espressif - WinUSB support for JTAG (ESP32-C3/S3)" in order to resolve this issue. If you don't want to re-run the installer then the same can be achieved with `idf-env <https://github.com/espressif/idf-env>`_ by running the following command from PowerShell::
Invoke-WebRequest 'https://dl.espressif.com/dl/idf-env/idf-env.exe' -OutFile .\idf-env.exe; .\idf-env.exe driver install --espressif
On Linux adding OpenOCD udev rules is required and is done by placing the following `udev rules file <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ in the ``/etc/udev/rules.d`` folder.

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

@@ -74,7 +74,7 @@ Linux
crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1
3. Following section "Permissions delegation" in `OpenOCD's README <https://sourceforge.net/p/openocd/code/ci/master/tree/README>`_, set up the access permissions to both USB ports.
3. To set up access permissions to OpenOCD supported USB devices, place the following `udev rules file <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ in the ``/etc/udev/rules.d`` folder.
4. Log off and login, then cycle the power to the board to make the changes effective. In terminal enter again ``ls -l /dev/ttyUSB*`` command to verify, if group-owner has changed from ``dialout`` to ``plugdev``:

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

@@ -44,6 +44,7 @@ Configure Drivers
You may need to install driver software to make JTAG work with computer. Refer to documentation of your JTAG adapter for related details.
On Linux adding OpenOCD udev rules is required and is done by placing the following `udev rules file <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ in the ``/etc/udev/rules.d`` folder.
Connect
^^^^^^^