Skip to content

Commit cd2c98e

Browse files
radimkarnisradimkarnis
committed
docs(set_flash_voltage): Disable for non-related chips
1 parent d27ce37 commit cd2c98e

File tree

1 file changed

+99
-97
lines changed

1 file changed

+99
-97
lines changed

‎docs/en/espefuse/set-flash-voltage-cmd.rst‎

Lines changed: 99 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -19,143 +19,145 @@ Positional arguments:
1919

2020
.. note::
2121

22-
This command is not supported. The tool prints the error ``set-flash-voltage not supported!``.
22+
Setting flash voltage is not supported on {IDF_TARGET_NAME}. The tool prints the error ``set-flash-voltage not supported!``.
2323

24-
Setting Flash Voltage ({IDF_TARGET_VDD_SPI})
25-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
.. only:: esp32 or esp32s2 or esp32s3
2625

27-
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}).
26+
Setting Flash Voltage ({IDF_TARGET_VDD_SPI})
27+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2828

29-
The default behavior on reset is:
29+
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}).
3030

31-
+--------------------+--------------------+
32-
| MTDI | Internal Regulator |
33-
+====================+====================+
34-
| Low or unconnected | Enabled at 3.3V |
35-
+--------------------+--------------------+
36-
| High | Enabled at 1.8V |
37-
+--------------------+--------------------+
31+
The default behavior on reset is:
3832

39-
.. only:: esp32
33+
+--------------------+--------------------+
34+
| MTDI | Internal Regulator |
35+
+====================+====================+
36+
| Low or unconnected | Enabled at 3.3V |
37+
+--------------------+--------------------+
38+
| High | Enabled at 1.8V |
39+
+--------------------+--------------------+
4040

41-
Consult ESP32 Technical Reference Manual chapter 4.8.1 "{IDF_TARGET_VDD_SPI} Power Domain" for details.
41+
.. only:: esp32
4242

43-
.. only:: not esp32
43+
Consult ESP32 Technical Reference Manual chapter 4.8.1 "{IDF_TARGET_VDD_SPI} Power Domain" for details.
4444

45-
Consult {IDF_TARGET_NAME} Technical Reference Manual for details.
45+
.. only:: not esp32
4646

47-
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:
47+
Consult {IDF_TARGET_NAME} Technical Reference Manual for details.
4848

49-
Disable {IDF_TARGET_VDD_SPI} Regulator
50-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
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:
5150

52-
.. code-block:: none
51+
Disable {IDF_TARGET_VDD_SPI} Regulator
52+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5353

54-
espefuse set-flash-voltage OFF
54+
.. code-block:: none
5555
56-
Once set:
56+
espefuse set-flash-voltage OFF
5757
58-
* {IDF_TARGET_VDD_SPI} regulator always disabled.
59-
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
60-
* Flash must be powered externally and voltage supplied to {IDF_TARGET_VDD_SPI} pin of {IDF_TARGET_NAME}.
61-
* eFuse ``{IDF_TARGET_VDD_FORCE}`` is burned.
58+
Once set:
6259

63-
Fixed 1.8V {IDF_TARGET_VDD_SPI}
64-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60+
* {IDF_TARGET_VDD_SPI} regulator always disabled.
61+
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
62+
* Flash must be powered externally and voltage supplied to {IDF_TARGET_VDD_SPI} pin of {IDF_TARGET_NAME}.
63+
* eFuse ``{IDF_TARGET_VDD_FORCE}`` is burned.
6564

66-
.. code-block:: none
65+
Fixed 1.8V {IDF_TARGET_VDD_SPI}
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6767

68-
espefuse set-flash-voltage 1.8V
68+
.. code-block:: none
6969
70-
Once set:
70+
espefuse set-flash-voltage 1.8V
7171
72-
* {IDF_TARGET_VDD_SPI} regulator always enables at 1.8V.
73-
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
74-
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
75-
* Efuses ``{IDF_TARGET_VDD_FORCE}`` and ``{IDF_TARGET_VDD_REG}`` are burned.
72+
Once set:
7673

77-
Fixed 3.3V {IDF_TARGET_VDD_SPI}
78-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74+
* {IDF_TARGET_VDD_SPI} regulator always enables at 1.8V.
75+
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
76+
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
77+
* Efuses ``{IDF_TARGET_VDD_FORCE}`` and ``{IDF_TARGET_VDD_REG}`` are burned.
7978

80-
.. code-block:: none
79+
Fixed 3.3V {IDF_TARGET_VDD_SPI}
80+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8181

82-
espefuse set-flash-voltage 3.3V
82+
.. code-block:: none
8383
84-
Once set:
84+
espefuse set-flash-voltage 3.3V
8585
86-
* {IDF_TARGET_VDD_SPI} regulator always enables at 3.3V.
87-
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
88-
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
89-
* Efuses ``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}`` are burned.
86+
Once set:
9087

91-
Subsequent Changes
92-
^^^^^^^^^^^^^^^^^^
88+
* {IDF_TARGET_VDD_SPI} regulator always enables at 3.3V.
89+
* MTDI pin ({IDF_TARGET_VDD_GPIO}) is ignored.
90+
* External voltage should not be supplied to {IDF_TARGET_VDD_SPI}.
91+
* Efuses ``{IDF_TARGET_VDD_FORCE}``, ``{IDF_TARGET_VDD_REG}``, ``{IDF_TARGET_VDD_TIEH}`` are burned.
9392

94-
Once an eFuse is burned it cannot be un-burned. However, changes can be made by burning additional eFuses:
93+
Subsequent Changes
94+
^^^^^^^^^^^^^^^^^^
9595

96-
* ``set-flash-voltage OFF`` can be changed to ``1.8V`` or ``3.3V``
97-
* ``set-flash-voltage 1.8V`` can be changed to ``3.3V``
96+
Once an eFuse is burned it cannot be un-burned. However, changes can be made by burning additional eFuses:
9897

98+
* ``set-flash-voltage OFF`` can be changed to ``1.8V`` or ``3.3V``
99+
* ``set-flash-voltage 1.8V`` can be changed to ``3.3V``
99100

100-
.. only:: esp32s2 or esp32s3
101101

102-
.. code-block:: none
102+
.. only:: esp32s2 or esp32s3
103103

104-
> espefuse set-flash-voltage 1.8V
104+
.. code-block:: none
105105
106-
=== Run "set-flash-voltage" command ===
107-
Set internal flash voltage regulator (VDD_SPI) to 1.8V.
106+
> espefuse set-flash-voltage 1.8V
108107
109-
VDD_SPI setting complete.
108+
=== Run "set-flash-voltage" command ===
109+
Set internal flash voltage regulator (VDD_SPI) to 1.8V.
110110
111-
Check all blocks for burn...
112-
idx, BLOCK_NAME, Conclusion
113-
[00] BLOCK0 is empty, will burn the new value
114-
.
115-
This is an irreversible operation!
116-
Type 'BURN' (all capitals) to continue.
117-
BURN
118-
BURN BLOCK0 - OK (write block == read block)
119-
Reading updated efuses...
120-
Successful
111+
VDD_SPI setting complete.
121112
113+
Check all blocks for burn...
114+
idx, BLOCK_NAME, Conclusion
115+
[00] BLOCK0 is empty, will burn the new value
116+
.
117+
This is an irreversible operation!
118+
Type 'BURN' (all capitals) to continue.
119+
BURN
120+
BURN BLOCK0 - OK (write block == read block)
121+
Reading updated efuses...
122+
Successful
122123
123-
.. code-block:: none
124124
125-
> espefuse set-flash-voltage 3.3V
125+
.. code-block:: none
126126
127-
=== Run "set-flash-voltage" command ===
128-
Enable internal flash voltage regulator (VDD_SPI) to 3.3V.
127+
> espefuse set-flash-voltage 3.3V
129128
130-
VDD_SPI setting complete.
129+
=== Run "set-flash-voltage" command ===
130+
Enable internal flash voltage regulator (VDD_SPI) to 3.3V.
131131
132-
Check all blocks for burn...
133-
idx, BLOCK_NAME, Conclusion
134-
[00] BLOCK0 is empty, will burn the new value
135-
.
136-
This is an irreversible operation!
137-
Type 'BURN' (all capitals) to continue.
138-
BURN
139-
BURN BLOCK0 - OK (write block == read block)
140-
Reading updated efuses...
141-
Successful
132+
VDD_SPI setting complete.
142133
134+
Check all blocks for burn...
135+
idx, BLOCK_NAME, Conclusion
136+
[00] BLOCK0 is empty, will burn the new value
137+
.
138+
This is an irreversible operation!
139+
Type 'BURN' (all capitals) to continue.
140+
BURN
141+
BURN BLOCK0 - OK (write block == read block)
142+
Reading updated efuses...
143+
Successful
143144
144-
.. code-block:: none
145145
146-
> espefuse set-flash-voltage OFF
147-
148-
=== Run "set-flash-voltage" command ===
149-
Disable internal flash voltage regulator (VDD_SPI). SPI flash will
150-
VDD_SPI setting complete.
151-
152-
Check all blocks for burn...
153-
idx, BLOCK_NAME, Conclusion
154-
[00] BLOCK0 is empty, will burn the new value
155-
.
156-
This is an irreversible operation!
157-
Type 'BURN' (all capitals) to continue.
158-
BURN
159-
BURN BLOCK0 - OK (write block == read block)
160-
Reading updated efuses...
161-
Successful
146+
.. code-block:: none
147+
148+
> espefuse set-flash-voltage OFF
149+
150+
=== Run "set-flash-voltage" command ===
151+
Disable internal flash voltage regulator (VDD_SPI). SPI flash will
152+
VDD_SPI setting complete.
153+
154+
Check all blocks for burn...
155+
idx, BLOCK_NAME, Conclusion
156+
[00] BLOCK0 is empty, will burn the new value
157+
.
158+
This is an irreversible operation!
159+
Type 'BURN' (all capitals) to continue.
160+
BURN
161+
BURN BLOCK0 - OK (write block == read block)
162+
Reading updated efuses...
163+
Successful

0 commit comments

Comments
 (0)