feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'docs/simplify_udev_rules_instructions' into 'master'

Browse Source 
docs: Simplify OpenOCD udev rules instructions for manual Linux installation

See merge request espressif/esp-idf!22628
This commit is contained in:
Roland Dobai
2023-03-17 14:30:23 +08:00
parent 3f3a2cf560 a44c68dfe0
commit b08d08d766
5 changed files with 6 additions and 2 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:: 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 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 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 USB devices supported by OpenOCD, copy the `udev rules file <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ into the ``/etc/udev/rules.d`` directory.
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``: 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. 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 copying the `udev rules file <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ into the ``/etc/udev/rules.d`` directory.
Connect Connect
^^^^^^^ ^^^^^^^

2
docs/zh_CN/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 crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1
3. 根据 `OpenOCD README 文档 <https://sourceforge.net/p/openocd/code/ci/master/tree/README>`_ 中 “Permissions delegation” 小节的介绍，设置这两个 USB 端口的访问权限。 3. 设置 OpenOCD 所支持 USB 设备的访问权限，请将 `udev 规则文件 <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ 复制到 ``/etc/udev/rules.d`` 目录中。
4. 注销并重新登录 Linux 系统，然后重新插拔板子的电源使之前的改动生效。在终端再次输入 ``ls -l /dev/ttyUSB*`` 命令进行验证，查看这两个设备的组所有者是否已经从 ``dialout`` 更改为 ``plugdev``: 4. 注销并重新登录 Linux 系统，然后重新插拔板子的电源使之前的改动生效。在终端再次输入 ``ls -l /dev/ttyUSB*`` 命令进行验证，查看这两个设备的组所有者是否已经从 ``dialout`` 更改为 ``plugdev``:

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

@@ -44,6 +44,7 @@
您可能还需要安装软件驱动，才能使 JTAG 在计算机上正常工作，请参阅您所使用的 JTAG 适配器的有关文档，获取相关详细信息。 您可能还需要安装软件驱动，才能使 JTAG 在计算机上正常工作，请参阅您所使用的 JTAG 适配器的有关文档，获取相关详细信息。
在 Linux 中，请务必将 `udev 规则文件 <https://github.com/espressif/openocd-esp32/blob/master/contrib/60-openocd.rules>`_ 复制到 ``/etc/udev/rules.d`` 目录中，以添加 OpenOCD udev 规则。
连接 连接
^^^^ ^^^^