alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update qemu guide for efuse commands

Browse Source 
- add mention of qemu guide in security related chapters
- also added a note about secure boot v2 config in qemu workflow
This commit is contained in:
Mahavir Jain
2024-09-26 20:50:04 +05:30
parent d6c4cbb53f
commit 1e94096e16
3 changed files with 39 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/en/api-guides/tools/qemu.rst
View File

@@ -1,6 +1,8 @@
QEMU Emulator
=============
{IDF_TARGET_CRYPT_CNT:default="SPI_BOOT_CRYPT_CNT",esp32="FLASH_CRYPT_CNT"}
:link_to_translation:`zh_CN:[中文]`
Espressif maintains a `fork <https://github.com/espressif/qemu>`_ of the QEMU emulator with support for {IDF_TARGET_NAME}. This fork implements emulation of the CPU, memory, and several peripherals of {IDF_TARGET_NAME}. For more information about QEMU for {IDF_TARGET_NAME}, see the `QEMU README documentation <https://github.com/espressif/esp-toolchain-docs/blob/main/qemu/README.md>`_.
@@ -119,13 +121,37 @@ QEMU supports emulation of eFuses. This can be a convenient way to test security
You can use :doc:`idf.py<idf-py>` eFuse-related commands to program eFuses. When you run any of these commands together with ``qemu`` command, the eFuses are programmed in QEMU, and the ``qemu_efuse.bin`` file is updated. For example,
.. only:: not SOC_FLASH_ENCRYPTION_XTS_AES
.. code-block:: console
idf.py qemu efuse-burn {IDF_TARGET_CRYPT_CNT} 1
idf.py qemu efuse-burn-key flash_encryption my_flash_encryption_key.bin
.. only:: SOC_FLASH_ENCRYPTION_XTS_AES
.. code-block:: console
idf.py qemu efuse-burn {IDF_TARGET_CRYPT_CNT} 1
idf.py qemu efuse-burn-key BLOCK my_flash_encryption_key.bin KEYPURPOSE
For details regarding the ``BLOCK`` and ``KEYPURPOSE``, please refer to the :doc:`../../security/flash-encryption` guide.
To dump the eFuse summary, please use the following command:
.. code-block:: console
idf.py qemu efuse-burn FLASH_CRYPT_CNT 1
idf.py qemu efuse-summary
By default, the values of eFuses are read from and written to the ``qemu_efuse.bin`` file in the build directory. You can specify a different file using the ``--efuse-file`` option. For example,
.. code-block:: console
idf.py qemu --efuse-file my_efuse.bin efuse-burn FLASH_CRYPT_CNT 1
idf.py qemu --efuse-file my_efuse.bin efuse-burn {IDF_TARGET_CRYPT_CNT} 1
idf.py qemu --efuse-file my_efuse.bin monitor
Emulating Secure Boot
~~~~~~~~~~~~~~~~~~~~~
QEMU supports emulation of secure boot v2 scheme. Please keep :ref:`CONFIG_SECURE_BOOT_FLASH_BOOTLOADER_DEFAULT` enabled to include signed bootloader image into the qemu image artifact.