From 6d37e30e2baa0a836e0ebe95f21038d197b93ea0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radim=20Karni=C5=A1?= Date: Wed, 2 Oct 2024 13:39:31 +0200 Subject: [PATCH] docs(spi_connection): Explain which flash chips are supported Closes https://github.com/espressif/esptool/issues/1015 --- docs/en/esptool/advanced-options.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en/esptool/advanced-options.rst b/docs/en/esptool/advanced-options.rst index db47b8aa04..53ede5cf2f 100644 --- a/docs/en/esptool/advanced-options.rst +++ b/docs/en/esptool/advanced-options.rst @@ -71,14 +71,18 @@ Passing ``--no-stub`` will disable certain options, as not all options are imple Overriding SPI Flash Connections -------------------------------- - 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. + 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. Supply the ``--spi-connection`` argument after the ``esptool.py`` command, ie ``esptool.py flash_id --spi-connection HSPI``. + .. note:: + + 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. + Default Behavior ^^^^^^^^^^^^^^^^ - If the ``--spi-connection`` argument is not provided, the SPI flash is configured to use :ref:`pin numbers set in efuse `. These are the same SPI flash pins that are used during a normal boot. + If the ``--spi-connection`` argument is not provided, the SPI flash is configured to use :ref:`pin numbers set in eFuse `. These are the same SPI flash pins that are used during a normal boot. 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.