mirror of
https://github.com/espressif/esptool.git
synced 2025-10-16 23:06:31 +08:00
docs(set_flash_voltage): Disable for non-related chips
This commit is contained in:
Radim Karniš
@@ -19,143 +19,145 @@ Positional arguments:
|
||||
|
||||
.. note::
|
||||
|
||||
This command is not supported. The tool prints the error ``set-flash-voltage not supported!``.
|
||||
Setting flash voltage is not supported on {IDF_TARGET_NAME}. The tool prints the error ``set-flash-voltage not supported!``.
|
||||
|
||||
Setting Flash Voltage ({IDF_TARGET_VDD_SPI})
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
.. only:: esp32 or esp32s2 or esp32s3
|
||||
|
||||
After reset, the default {IDF_TARGET_NAME} behavior is to enable and configure the flash voltage regulator ({IDF_TARGET_VDD_SPI}) based on the level of the MTDI pin ({IDF_TARGET_VDD_GPIO}).
|
||||
Setting Flash Voltage ({IDF_TARGET_VDD_SPI})
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The default behavior on reset is:
|
||||
After reset, the default {IDF_TARGET_NAME} behavior is to enable and configure the flash voltage regulator ({IDF_TARGET_VDD_SPI}) based on the level of the MTDI pin ({IDF_TARGET_VDD_GPIO}).
|
||||
|
||||
+--------------------+--------------------+
|
||||
| MTDI | Internal Regulator |
|
||||
+====================+====================+
|
||||
| Low or unconnected | Enabled at 3.3V |
|
||||
+--------------------+--------------------+
|
||||
| High | Enabled at 1.8V |
|
||||
+--------------------+--------------------+
|
||||
The default behavior on reset is:
|
||||
|
||||
.. only:: esp32
|
||||
+--------------------+--------------------+
|
||||
| MTDI | Internal Regulator |
|
||||
+====================+====================+
|
||||
| Low or unconnected | Enabled at 3.3V |
|
||||
+--------------------+--------------------+
|
||||
| High | Enabled at 1.8V |
|
||||
+--------------------+--------------------+
|
||||
|
||||
Consult ESP32 Technical Reference Manual chapter 4.8.1 "{IDF_TARGET_VDD_SPI} Power Domain" for details.
|
||||
.. only:: esp32
|
||||
|
||||
.. only:: not esp32
|
||||
Consult ESP32 Technical Reference Manual chapter 4.8.1 "{IDF_TARGET_VDD_SPI} Power Domain" for details.
|
||||
|
||||
Consult {IDF_TARGET_NAME} Technical Reference Manual for details.
|
||||
.. only:: not esp32
|
||||
|
||||
A combination of 3 eFuses (``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}``) can be burned in order to override this behavior and disable {IDF_TARGET_VDD_SPI} regulator, or set it to a fixed voltage. These eFuses can be burned with individual ``burn-efuse`` commands, but the ``set-flash-voltage`` command makes it easier:
|
||||
Consult {IDF_TARGET_NAME} Technical Reference Manual for details.
|
||||
|
||||
Disable {IDF_TARGET_VDD_SPI} Regulator
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
A combination of 3 eFuses (``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}``) can be burned in order to override this behavior and disable {IDF_TARGET_VDD_SPI} regulator, or set it to a fixed voltage. These eFuses can be burned with individual ``burn-efuse`` commands, but the ``set-flash-voltage`` command makes it easier:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
espefuse set-flash-voltage OFF
|
||||
|
||||
Once set:
|
||||
|
||||
* {IDF_TARGET_VDD_SPI} regulator always disabled.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* Flash must be powered externally and voltage supplied to {IDF_TARGET_VDD_SPI} pin of {IDF_TARGET_NAME}.
|
||||
* eFuse ``{IDF_TARGET_VDD_FORCE}`` is burned.
|
||||
|
||||
Fixed 1.8V {IDF_TARGET_VDD_SPI}
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
espefuse set-flash-voltage 1.8V
|
||||
|
||||
Once set:
|
||||
|
||||
* {IDF_TARGET_VDD_SPI} regulator always enables at 1.8V.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
|
||||
* Efuses ``{IDF_TARGET_VDD_FORCE}`` and ``{IDF_TARGET_VDD_REG}`` are burned.
|
||||
|
||||
Fixed 3.3V {IDF_TARGET_VDD_SPI}
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
espefuse set-flash-voltage 3.3V
|
||||
|
||||
Once set:
|
||||
|
||||
* {IDF_TARGET_VDD_SPI} regulator always enables at 3.3V.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
|
||||
* Efuses ``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}`` are burned.
|
||||
|
||||
Subsequent Changes
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Once an eFuse is burned it cannot be un-burned. However, changes can be made by burning additional eFuses:
|
||||
|
||||
* ``set-flash-voltage OFF`` can be changed to ``1.8V`` or ``3.3V``
|
||||
* ``set-flash-voltage 1.8V`` can be changed to ``3.3V``
|
||||
|
||||
|
||||
.. only:: esp32s2 or esp32s3
|
||||
Disable {IDF_TARGET_VDD_SPI} Regulator
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage 1.8V
|
||||
espefuse set-flash-voltage OFF
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Set internal flash voltage regulator (VDD_SPI) to 1.8V.
|
||||
Once set:
|
||||
|
||||
VDD_SPI setting complete.
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
* {IDF_TARGET_VDD_SPI} regulator always disabled.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* Flash must be powered externally and voltage supplied to {IDF_TARGET_VDD_SPI} pin of {IDF_TARGET_NAME}.
|
||||
* eFuse ``{IDF_TARGET_VDD_FORCE}`` is burned.
|
||||
|
||||
Fixed 1.8V {IDF_TARGET_VDD_SPI}
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage 3.3V
|
||||
espefuse set-flash-voltage 1.8V
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Enable internal flash voltage regulator (VDD_SPI) to 3.3V.
|
||||
Once set:
|
||||
|
||||
VDD_SPI setting complete.
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
* {IDF_TARGET_VDD_SPI} regulator always enables at 1.8V.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
|
||||
* Efuses ``{IDF_TARGET_VDD_FORCE}`` and ``{IDF_TARGET_VDD_REG}`` are burned.
|
||||
|
||||
Fixed 3.3V {IDF_TARGET_VDD_SPI}
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage OFF
|
||||
espefuse set-flash-voltage 3.3V
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Disable internal flash voltage regulator (VDD_SPI). SPI flash will
|
||||
VDD_SPI setting complete.
|
||||
Once set:
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
* {IDF_TARGET_VDD_SPI} regulator always enables at 3.3V.
|
||||
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
|
||||
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
|
||||
* Efuses ``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}`` are burned.
|
||||
|
||||
Subsequent Changes
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Once an eFuse is burned it cannot be un-burned. However, changes can be made by burning additional eFuses:
|
||||
|
||||
* ``set-flash-voltage OFF`` can be changed to ``1.8V`` or ``3.3V``
|
||||
* ``set-flash-voltage 1.8V`` can be changed to ``3.3V``
|
||||
|
||||
|
||||
.. only:: esp32s2 or esp32s3
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage 1.8V
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Set internal flash voltage regulator (VDD_SPI) to 1.8V.
|
||||
|
||||
VDD_SPI setting complete.
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage 3.3V
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Enable internal flash voltage regulator (VDD_SPI) to 3.3V.
|
||||
|
||||
VDD_SPI setting complete.
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
> espefuse set-flash-voltage OFF
|
||||
|
||||
=== Run "set-flash-voltage" command ===
|
||||
Disable internal flash voltage regulator (VDD_SPI). SPI flash will
|
||||
VDD_SPI setting complete.
|
||||
|
||||
Check all blocks for burn...
|
||||
idx, BLOCK_NAME, Conclusion
|
||||
[00] BLOCK0 is empty, will burn the new value
|
||||
.
|
||||
This is an irreversible operation!
|
||||
Type 'BURN' (all capitals) to continue.
|
||||
BURN
|
||||
BURN BLOCK0 - OK (write block == read block)
|
||||
Reading updated efuses...
|
||||
Successful
|
||||
|
||||
Reference in New Issue
Block a user