espressif/esptool
1
0
Fork 0
mirror of https://github.com/espressif/esptool.git synced 2025-10-18 00:32:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add chip type detection explanation

Browse Source
This commit is contained in:
Jaroslav Safka
2025-08-27 10:35:07 +02:00
parent 929ae7908f
commit 528f60525f
3 changed files with 74 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/en/advanced-topics/diag/chip_type_detection_chart.diag Normal file
View File

@@ -0,0 +1,37 @@
blockdiag chip_type_detection_chart {
node_height = 40;
node_width = 150;
span_width = 40;
span_height = 45;
default_fontsize = 12
orientation = portrait;
edge_layout = flowchart;
default_group_color = none;
// nodes
start [label = "Start", shape = flowchart.terminator];
get_chip_id [label = "get chip-id by\nget-security-info", shape = box];
id_success_cond [label = "Success?", shape = flowchart.condition];
reg_success_cond [label = "Success?", shape = flowchart.condition];
find_by_id [label = "Find ID in list", shape = box];
get_magic_reg [label = "Read magic register", shape = box];
find_by_reg [label = "Find magic number\nin list", shape = box];
try_esp32s2 [label = "detected ESP32-S2\nin SDM", shape = box];
finish [label = "Finish", shape = flowchart.terminator];
// edges
start -> get_chip_id -> id_success_cond;
id_success_cond -> find_by_id [label = "Yes"];
find_by_id -> finish;
id_success_cond -> get_magic_reg [label = "No"];
get_magic_reg -> reg_success_cond;
reg_success_cond -> find_by_reg [label = "Yes"];
find_by_reg -> finish;
reg_success_cond -> try_esp32s2 [label = "No"];
try_esp32s2 -> finish
}

6
docs/en/advanced-topics/diag/download_procedure_chart.diag
View File

@@ -10,7 +10,7 @@ blockdiag download_procedure_diagram {
// nodes
start [label = "Start", shape = flowchart.terminator];
sync [label = "Synchronization", shape = box];
init [label = "Initialization", shape = box];
success_cond [label = "Success?", shape = flowchart.condition];
erase_data [label = "Erase data", shape = box];
transmit_data [label = "Transmit data", shape = box];
@@ -22,11 +22,11 @@ blockdiag download_procedure_diagram {
fincon_fin [shape = none];
// edges
start -> sync -> success_cond;
start -> init -> success_cond;
success_cond -> erase_data [label = "Yes"];
erase_data -> transmit_data;
transmit_data -> finish_cond;
success_cond -- succ_fin [label = "Timeout"];
success_cond -- succ_fin [label = "Failure"];
finish_cond -> transmit_finish [label = "Yes"];
finish_cond -- fincon_fin [label = "Failure"];
succ_fin -- fincon_fin;

37
docs/en/advanced-topics/serial-protocol.rst
View File

@@ -340,21 +340,52 @@ Functional Description
.. note::
This flow chart is used to illustrate the download procedure (writing to flash), other commands have different flows.
Initial Synchronisation
^^^^^^^^^^^^^^^^^^^^^^^
Initialization
^^^^^^^^^^^^^^
.. list::
:esp8266: * The ESP chip is reset into UART bootloader mode. The host starts by sending SYNC commands. These commands have a large data payload which is also used by the ESP chip to detect the configured baud rate. The ESP8266 will initialise at 74800bps with a 26MHz crystal and 115200bps with a 40MHz crystal. However the sync packets can be sent at any baud rate, and the UART peripheral will detect this.
:not esp8266: * The ESP chip is reset into UART bootloader mode. The host starts by sending SYNC commands. These commands have a large data payload which is also used by the ESP chip to detect the configured baud rate. {IDF_TARGET_NAME} always initialises at 115200bps. However the sync packets can be sent at any baud rate, and the UART peripheral will detect this.
* The host should wait until it sees a valid response to a SYNC command, indicating the ESP chip is correctly communicating.
* Chip type detection then uses various methods to identify chip type, subtype, revision, etc. See below.
* Esptool then (by default) uses the "RAM Download" sequence to upload :ref:`stub loader <stub>` code to IRAM of the chip. The MEM_END command contains the entry-point address to run the stub loader.
The stub loader then sends a custom SLIP packet of the sequence OHAI (``0xC0 0x4F 0x48 0x41 0x49 0xC0``), indicating that it is now running. This is the only unsolicited packet ever sent by the ESP.
If the ``--no-stub`` argument is supplied to esptool, this entire step is skipped.
* esptool then uses READ_REG commands to read various addresses on the chip, to identify chip subtype, revision, etc.
:not esp8266: * For commands which need to use the flash, the {IDF_TARGET_NAME} ROM an stub loader requires the SPI_ATTACH and SPI_SET_PARAMS commands. See `SPI Configuration Commands`_.
:esp8266: * For stub loader, the host can send a CHANGE_BAUD command to set the baud rate to an explicit value. Compared to auto-detecting during the SYNC pulse, this can be more reliable for setting very high baud rate. Esptool tries to sync at (maximum) 115200bps and then sends this command to go to a higher baud rate, if requested.
:not esp8266: * For stub loader and/or {IDF_TARGET_NAME} ROM loader, the host can send a CHANGE_BAUD command to set the baud rate to an explicit value. Compared to auto-detecting during the SYNC pulse, this can be more reliable for setting very high baud rate. Esptool tries to sync at (maximum) 115200bps and then sends this command to go to a higher baud rate, if requested.
Initialization - Chip Type Detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
{IDF_TARGET_NAME} Chip Detection
""""""""""""""""""""""""""""""""
.. only:: esp8266 or esp32
{IDF_TARGET_NAME} does not support **GET_SECURITY_INFO (0x14)** command and its **chip-id** value. So, chip is detected by using **READ_REG** and his magic value.
.. only:: esp32s2
{IDF_TARGET_NAME} supports the **GET_SECURITY_INFO (0x14)** command, but the output lacks the **chip-id**. Therefore, esptool uses the **magic register** as a fallback for this chip as well.
If reading the register also fails, it indicates the chip is in **secure download** mode.
.. only:: not esp8266 and not esp32 and not esp32s2
{IDF_TARGET_NAME} is detected by using **GET_SECURITY_INFO (0x14)** command and its **chip-id** value.
Overview of Detection for All Chips
"""""""""""""""""""""""""""""""""""
.. blockdiag:: diag/chip_type_detection_chart.diag
:caption: All chips detection flow chart
:align: center
On older devices that do not support the **GET_SECURITY_INFO (0x14)** command (which provides the **chip-id**), esptool falls back to reading a **magic register** to determine the chip type.
The main exception is the **ESP32-S2**: although it supports the **GET_SECURITY_INFO (0x14)** command, the output lacks the **chip-id**. Therefore, esptool uses the **magic register** as a fallback for this chip as well.
If reading the register also fails, it indicates the chip is in **secure download** mode.
For details see: `esptool chip detection code <https://github.com/espressif/esptool/blob/v5.0.2/esptool/cmds.py#L101>`__
Writing Data
^^^^^^^^^^^^