Merge branch 'docs/update_inconsistency_backport_v4.4' into 'release/v4.4'

docs: Update incorrect pins for S3 documentation, set a default value for future targets, and remove line breaks inside paragraphs (backport v4.4)

See merge request espressif/esp-idf!16367
This commit is contained in:
Krzysztof Budzynski 2022-01-27 08:26:07 +00:00
commit c02f6b96af

View File

@ -6,21 +6,23 @@
Configure {IDF_TARGET_NAME} built-in JTAG Interface
===================================================
{IDF_TARGET_NAME} has a built-in JTAG circuitry and can be debugged without any additional chip. Only an USB cable
connected to the D+/D- pins is necessary. The necessary connections are shown in the following section.
{IDF_TARGET_JTAG_PIN_Dneg:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19"}
{IDF_TARGET_JTAG_PIN_Dpos:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20"}
{IDF_TARGET_NAME} has a built-in JTAG circuitry and can be debugged without any additional chip. Only an USB cable connected to the D+/D- pins is necessary. The necessary connections are shown in the following section.
Configure Hardware
^^^^^^^^^^^^^^^^^^
.. list-table:: ESP32-C3 pins and USB signals
.. list-table:: {IDF_TARGET_NAME} pins and USB signals
:widths: 25 75
:header-rows: 1
* - ESP32-C3 Pin
* - {IDF_TARGET_NAME} Pin
- USB Signal
* - GPIO18
* - {IDF_TARGET_JTAG_PIN_Dneg}
- D-
* - GPIO19
* - {IDF_TARGET_JTAG_PIN_Dpos}
- D+
* - 5V
- V_BUS
@ -32,10 +34,6 @@ Please verify that the {IDF_TARGET_NAME} pins used for USB communication are not
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)" 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