You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/guides/tools_menu.rst
+63-14
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ For more details or to add a new board, see the `boards.txt`_ file.
28
28
Generic Options
29
29
---------------
30
30
31
-
Most of the options are available for every ESP32 families. Some options will be available only for specific targets, like the USB configuration.
31
+
Most of the options are available for every ESP32 family. Some options will be available only for specific targets, like the USB configuration.
32
32
33
33
Board
34
34
*****
@@ -57,19 +57,21 @@ CPU Frequency
57
57
58
58
On this option, you can select the CPU clock frequency. This option is critical and must be selected according to the high-frequency crystal present on the board and the radio usage (Wi-Fi and Bluetooth).
59
59
60
-
In some application, reducing the CPU clock frequency is recommended in order to reduce the power consumption.
60
+
In some applications, reducing the CPU clock frequency is recommended in order to reduce power consumption.
61
61
62
62
If you don't know why you should change this frequency, leave the default option.
63
63
64
64
Flash Frequency
65
65
***************
66
66
67
-
Use this function to select the flash memory frequency. The frequency will be dependent of the memory model.
67
+
Use this function to select the flash memory frequency. The frequency will be dependent on the memory model.
68
68
69
69
* **40MHz**
70
70
* **80MHz**
71
71
72
-
If you don't know if your memory supports **80Mhz**, you can try to upload you scketch using the **80MHz** option and watch the log output via the serial monitor.
72
+
If you don't know if your memory supports **80Mhz**, you can try to upload the sketch using the **80MHz** option and watch the log output via the serial monitor.
73
+
74
+
.. note:: In some boards/SoC, the flash frequency is automatically selected according to the flash mode. In some cases (i.e ESP32-S3), the flash frequency is up to 120MHz.
73
75
74
76
Flash Mode
75
77
**********
@@ -79,17 +81,20 @@ This option is used to select the SPI communication mode with the flash memory.
79
81
Depending on the application, this mode can be changed in order to increase the flash communication speed.
80
82
81
83
* **QIO** - Quad I/O Fast Read
82
-
* Four SPI pins are used to write to the flash and to read from flash.
84
+
* Four SPI pins are used to write to the flash and to read from the flash.
83
85
84
86
* **DIO** - Dual I/O Fast Read
85
-
* Two SPI pins are used to write to the flash and to read from flash.
87
+
* Two SPI pins are used to write to the flash and to read from the flash.
86
88
87
89
* **QOUT** - Quad Output Fast Read
88
90
* Four SPI pins are used to read the flash data.
89
91
90
92
* **DOUT** - Dual Output Fast Read
91
93
* Two SPI pins are used to read flash data.
92
94
95
+
* **OPI** - Octal I/O
96
+
* Eight SPI pins are used to write and to read from the flash.
97
+
93
98
If you don't know how the board flash is physically connected or the flash memory model, try the **QIO** at **80MHz** first.
94
99
95
100
Flash Size
@@ -104,7 +109,29 @@ This option is used to select the flash size. The flash size should be selected
104
109
105
110
If you choose the wrong size, you may have issues when selecting the partition scheme.
106
111
112
+
Embedded Flash
113
+
^^^^^^^^^^^^^^
114
+
115
+
Some SoC has embedded flash. The ESP32-S3 is a good example.
116
+
117
+
.. note:: Check the manufacturer part number of your SoC/module to see the right version.
118
+
119
+
Example: **ESP32-S3FH4R2**
120
+
121
+
This particular ESP32-S3 variant comes with 4MB Flash and 2MB PSRAM.
107
122
123
+
**Options for Embedded Flash**
124
+
125
+
* **Fx4** 4MB Flash (*QIO*)
126
+
* **Fx8** 8MB Flash (*QIO*)
127
+
* **V** 1.8V SPI
128
+
129
+
The **x** stands for the temperature range specification.
130
+
131
+
* **H** High Temperature (*-40 to 85ºC*)
132
+
* **N** Low Temeprature (*-40 to 65ºC*)
133
+
134
+
For more details, please see the corresponding datasheet at `Espressif Product Selector`_.
108
135
109
136
Partition Scheme
110
137
****************
@@ -130,21 +157,44 @@ PSRAM
130
157
131
158
The PSRAM is an internal or external extended RAM present on some boards, modules or SoC.
132
159
133
-
This option can be used to ``Enable`` or ``Disable`` the PSRAM.
160
+
This option can be used to ``Enable`` or ``Disable`` PSRAM. In some SoCs, you can select the PSRAM mode as the following.
161
+
162
+
* **QSPI PSRAM** - Quad PSRAM
163
+
* **OPI PSRAM** - Octal PSRAM
164
+
165
+
Embedded PSRAM
166
+
^^^^^^^^^^^^^^
167
+
168
+
Some SoC has embedded PSRAM. The ESP32-S3 is a good example.
169
+
170
+
Example: **ESP32-S3FH4R2**
171
+
172
+
This particular ESP32-S3 comes with 4MB Flash and 2MB PSRAM.
173
+
174
+
**Options for Embedded Flash and PSRAM**
175
+
176
+
* **R2** 2MB PSRAM (*QSPI*)
177
+
* **R8** 8MB PSRAM (*OPI*)
178
+
* **V** 1.8V SPI
179
+
180
+
The **x** stands for the temperature range specification.
181
+
182
+
* **H** High Temperature (*-40 to 85ºC*)
183
+
* **N** Low Temeprature (*-40 to 65ºC*)
184
+
185
+
For more details, please see the corresponding datasheet at `Espressif Product Selector`_.
134
186
135
187
Arduino Runs On
136
188
***************
137
189
138
190
This function is used to select the core that runs the Arduino core. This is only valid if the target SoC has 2 cores.
139
191
140
-
When you have some heavy task running, you might want to run this task on a different core then the Arduino tasks. For this reason, you have this configuration to select the core.
192
+
When you have some heavy task running, you might want to run this task on a different core than the Arduino tasks. For this reason, you have this configuration to select the right core.
141
193
142
194
Events Run On
143
195
*************
144
196
145
-
This function is used to select the core that runs the events. This is only valid if the target SoC has 2 cores.
146
-
147
-
The same situation on the previous configuration.
197
+
This function is also used to select the core that runs the Arduino events. This is only valid if the target SoC has 2 cores.
148
198
149
199
Port
150
200
****
@@ -180,7 +230,7 @@ USB Firmware MSC On Boot
180
230
The USB Mass Storage Class, or USB MSC, is a class used for storage devices, like a USB flash drive.
181
231
182
232
This option can be used to ``Enable`` or ``Disable`` this function at the boot. If this option is ``Enabled``, once the device is connected via USB, one new storage device will appear in the system as a storage drive.
183
-
Use this new storage drive to write or read files, or to drop a new firmware binary to flash the device.
233
+
Use this new storage drive to write and read files or to drop a new firmware binary to flash the device.
184
234
185
235
.. figure:: ../_static/usb_msc_drive.png
186
236
:align:center
@@ -194,6 +244,5 @@ The USB Device Firmware Upgrade is a class used for flashing the device through
194
244
195
245
This option can be used to ``Enable`` or ``Disable`` this function at the boot. If this option is ``Enabled``, once the device is connected via USB, the device will appear as a USB DFU capable device.
0 commit comments