Merge branch 'docs/idf_size_flash_total_size' into 'master'

fix(docs/idf-size): add explicit note about total flash size

Closes IDF-13066

See merge request espressif/esp-idf!38891
This commit is contained in:
Frantisek Hrbata
2025-06-20 08:15:43 +02:00

View File

@ -12,25 +12,32 @@ This output provides a summary of the statically-allocated memory for different
.. code-block:: bash
$ idf.py size
Memory Type Usage Summary
Memory Type Usage Summary
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Memory Type/Section ┃ Used [bytes] ┃ Used [%] ┃ Remain [bytes] ┃ Total [bytes]
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ Flash Code │ 806662.4132616383342304
│ .text │ 806662.41 │ │ │
│ IRAM │ 51835 │ 39.55 │ 79237131072
│ .text │ 50807 │ 38.76 │ │ │
│ .vectors │ 1027 │ 0.78 │ │ │
│ Flash Data │ 382240.9141560484194272
│ .rodata │ 379680.91 │ │ │
│ .appdesc │ 2560.01 │ │ │
│ DRAM │ 112366.22169500180736
│ .data │ 8988 │ 4.97 │ │ │
│ .bss │ 2248 │ 1.24 │ │ │
│ Flash Code │ 64442
│ .text │ 64442 │ │ │
│ IRAM │ 51711 │ 39.45 │ 79361131072
│ .text │ 50683 │ 38.67 │ │ │
│ .vectors │ 1028 │ 0.78 │ │ │
│ Flash Data │ 30208
│ .rodata │ 29952 │ │ │
│ .appdesc │ 256 │ │ │
│ DRAM │ 107165.93170020180736
│ .data │ 8564 │ 4.74 │ │ │
│ .bss │ 2152 │ 1.19 │ │ │
│ RTC FAST │ 32 │ 0.39 │ 81608192
│ .force_fast │ 32 │ 0.39 │ │ │
│ RTC SLOW │ 24 │ 0.29 │ 81688192
│ .rtc_slow_reserved │ 24 │ 0.29 │ │ │
└───────────────────────┴──────────────┴──────────┴────────────────┴───────────────┘
Total image size: 179712 bytes (.bin may be padded larger)
Total image size: 154957 bytes (.bin may be padded larger)
Note: The reported total sizes may be smaller than those in the technical reference
manual due to reserved memory and application configuration. The total flash size
available for the application is not included by default, as it cannot be reliably
determined due to the presence of other data like the bootloader, partition table,
and application partition size.
Espressif chips include various :doc:`/api-guides/memory-types`, which are detailed in the `Technical Reference Manual (TRM) <{IDF_TARGET_TRM_EN_URL}>`__. These memory types are listed in the ``Memory Type`` column, along with the ELF ``Sections`` that are loaded into each type. The ``Used`` columns display the memory usage for each specific memory type or section. The ``Remain`` column indicates the remaining available memory for the specified memory type. The ``Total`` column shows the total available memory for that memory type, based on the memory region sizes defined in the linker script that map into the memory type.