Skip to content

Commit 6d37e30

Browse files
committed
docs(spi_connection): Explain which flash chips are supported
Closes espressif#1015
1 parent e720591 commit 6d37e30

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/en/esptool/advanced-options.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,18 @@ Passing ``--no-stub`` will disable certain options, as not all options are imple
7171
Overriding SPI Flash Connections
7272
--------------------------------
7373

74-
The optional ``--spi-connection`` argument overrides the SPI flash connection configuration on ESP32. This means that the SPI flash can be connected to other pins, or esptool can be used to communicate with a different SPI flash chip to the default.
74+
The optional ``--spi-connection`` argument overrides the SPI flash connection configuration on {IDF_TARGET_NAME}. This means that the SPI flash can be connected to other pins, or esptool can be used to communicate with a different SPI flash chip to the default.
7575

7676
Supply the ``--spi-connection`` argument after the ``esptool.py`` command, ie ``esptool.py flash_id --spi-connection HSPI``.
7777

78+
.. note::
79+
80+
Only NOR flash chips that are capable of at least Dual I/O (DIO) mode for SPI communication are supported. SPI NAND flash chips, as well as other types of memory devices that do not meet this requirement, are not supported.
81+
7882
Default Behavior
7983
^^^^^^^^^^^^^^^^
8084

81-
If the ``--spi-connection`` argument is not provided, the SPI flash is configured to use :ref:`pin numbers set in efuse <espefuse-spi-flash-pins>`. These are the same SPI flash pins that are used during a normal boot.
85+
If the ``--spi-connection`` argument is not provided, the SPI flash is configured to use :ref:`pin numbers set in eFuse <espefuse-spi-flash-pins>`. These are the same SPI flash pins that are used during a normal boot.
8286

8387
The only exception to this is if the ``--no-stub`` option is also provided. In this case, efuse values are ignored and ``--spi-connection`` will default to ``--spi-connection SPI`` unless set to a different value.
8488

0 commit comments

Comments
 (0)