Skip to content

Commit

Permalink
docs: Point directly to the datasheet for given target
Browse files Browse the repository at this point in the history
This also fixes ESP32-C3/ESP864 not linked correctly.
  • Loading branch information
Jan Beran authored and radimkarnis committed Jan 21, 2025
1 parent 98001b7 commit a32988e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/en/advanced-topics/boot-mode-selection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This guide explains how to select the boot mode correctly and describes the boot

The {IDF_TARGET_NAME} has a 45k ohm internal pull-up/pull-down resistor at {IDF_TARGET_STRAP_BOOT_GPIO} (and other pins). If you want to connect a switch button to enter the boot mode, this has to be a strong pull-down. For example a 10k resistor to GND.

Information about {IDF_TARGET_NAME} strapping pins can also be found in the `{IDF_TARGET_NAME} Datasheet <https://www.espressif.com/en/support/documents/technical-documents?keys={IDF_TARGET_NAME}+datasheet>`__, section "Strapping Pins".
Information about {IDF_TARGET_NAME} strapping pins can also be found in the `{IDF_TARGET_NAME} Datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`__, section "Strapping Pins".

On many development boards with built-in USB/Serial, ``esptool.py`` can automatically reset the board into bootloader mode. For other configurations or custom hardware, you will need to check the orientation of some "strapping pins" to get the correct boot mode:

Expand Down Expand Up @@ -99,7 +99,7 @@ This guide explains how to select the boot mode correctly and describes the boot

.. only:: not esp32

As well as the above mentioned pins, other ones influence the serial bootloader, please consult the `{IDF_TARGET_NAME} Datasheet <https://www.espressif.com/en/support/documents/technical-documents?keys={IDF_TARGET_NAME}+datasheet>`__, section "Strapping Pins".
As well as the above mentioned pins, other ones influence the serial bootloader, please consult the `{IDF_TARGET_NAME} Datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`__, section "Strapping Pins".

.. only:: esp32

Expand All @@ -113,7 +113,7 @@ This guide explains how to select the boot mode correctly and describes the boot
| 15 (MTDO) | If driven Low, silences boot messages printed by the ROM bootloader. Has an internal pull-up, so unconnected = High = normal output. |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For more information, consult the `{IDF_TARGET_NAME} Datasheet <https://www.espressif.com/en/support/documents/technical-documents?keys={IDF_TARGET_NAME}+datasheet>`__, section "Strapping Pins".
For more information, consult the `{IDF_TARGET_NAME} Datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`__, section "Strapping Pins".

.. _automatic-bootloader:

Expand Down
4 changes: 2 additions & 2 deletions docs/en/espefuse/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ espefuse.py

Because eFuse is one-time-programmable, it is possible to permanently damage or "brick" your {IDF_TARGET_NAME} using this tool. Use it with great care.

For more details about Espressif chips eFuse features, see the `Technical Reference Manual <https://www.espressif.com/en/support/documents/technical-documents>`__.
For more details about Espressif chips eFuse features, see the `{IDF_TARGET_NAME} Technical Reference Manual <{IDF_TARGET_TRM_EN_URL}>`__.

``espefuse.py`` is installed alongside ``esptool.py``, so if ``esptool.py`` (v2.0 or newer) is available on the PATH then ``espefuse.py`` should be as well.

Expand Down Expand Up @@ -169,7 +169,7 @@ For more details on the structure and usage of the CSV file, refer to the `eFuse
Recommendations
---------------

1. The `Technical Reference Manual <https://www.espressif.com/en/support/documents/technical-documents>`__ has a recommendation for reducing the number of burn operations as much as possible. The tool supports several ways to do this:
1. The `{IDF_TARGET_NAME} Technical Reference Manual <{IDF_TARGET_TRM_EN_URL}>`__ has a recommendation for reducing the number of burn operations as much as possible. The tool supports several ways to do this:

- Combine multiple commands into one with this :ref:`perform-multiple-operations` feature.
- Most commands support getting a list of arguments (eFuse names, keys).
Expand Down
2 changes: 1 addition & 1 deletion docs/en/esptool/flash-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ These set Quad Flash I/O or Dual Flash I/O modes. Valid values are ``keep``, ``q

Most {IDF_TARGET_NAME} modules use ``qio``, but are also dual I/O.

In ``qio`` mode, two additional GPIOs are used for SPI flash communications. If flash mode is set to ``dio`` then these pins are available for other purposes. Search for ``SPIWP`` and ``SPIHD`` pins in the `{IDF_TARGET_NAME} Technical Reference Manual <https://www.espressif.com/en/support/documents/technical-documents?keys={IDF_TARGET_NAME}+Technical+Reference+Manual>`__ to learn more.
In ``qio`` mode, two additional GPIOs are used for SPI flash communications. If flash mode is set to ``dio`` then these pins are available for other purposes. Search for ``SPIWP`` and ``SPIHD`` pins in the `{IDF_TARGET_NAME} Technical Reference Manual <{IDF_TARGET_TRM_EN_URL}>`__ to learn more.

For a full explanation of these modes, see the :ref:`SPI Flash Modes page <spi-flash-modes>`.

Expand Down

0 comments on commit a32988e

Please sign in to comment.