feat(examples): Get offsets for efuses from espefuse.py

Author: KonstantinKondrashov

examples/system/efuse/conftest.py

@@ -1,9 +1,12 @@
-# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
+import json
 import logging
 import os
+import tempfile
+from typing import Any
 
+import espefuse
 import pytest
 from _pytest.fixtures import FixtureRequest
 from _pytest.monkeypatch import MonkeyPatch
@@ -52,6 +55,12 @@ def bootloader_flash(self) -> None:
         # Restore self.app.flash files to original value
         self.app.flash_files = prev_flash_files
 
+    def erase_field_on_emul_efuse_by_name(self, efuse_names: list) -> None:
+        pos_of_bits = []
+        for name in efuse_names:
+            pos_of_bits.append(self.get_efuse_offset(name))
+        self.erase_field_on_emul_efuse(pos_of_bits)
+
     def erase_field_on_emul_efuse(self, pos_of_bits: list) -> None:
         emul_efuse_bin_path = os.path.join(self.app.binary_path, 'emul_efuse.bin')
         self.dump_flash(output=emul_efuse_bin_path, partition='emul_efuse')
@@ -86,6 +95,20 @@ def erase_bit(pos_of_bit: int) -> None:
         self.flash()
         self.app.flash_files = prev_flash_files
 
+    def get_efuse_offset(self, efuse_name: str) -> Any:
+        with tempfile.NamedTemporaryFile(suffix='.json') as temp_file:
+            temp_file_path = temp_file.name
+            espefuse.main(f'--virt -c {self.target} summary --format json --file {temp_file_path}'.split())
+            with open(temp_file_path, 'r') as file:
+                efuse_summary = json.load(file)
+                if efuse_name in efuse_summary:
+                    data = efuse_summary[efuse_name]
+                    offset = int(data['word'] * 32) + data['pos']
+                    print(f'{efuse_name} offset = {offset}')
+                    return offset
+                else:
+                    raise ValueError(f"eFuse '{efuse_name}' not found in the summary.")
+
 
 @pytest.fixture(scope='module')
 def monkeypatch_module(request: FixtureRequest) -> MonkeyPatch:

examples/system/efuse/pytest_system_efuse_example.py

@@ -174,23 +174,12 @@ def test_examples_efuse_with_virt_flash_enc_pre_loaded(dut: Dut) -> None:
     dut.expect('example: Done')
 
     if dut.app.target == 'esp32':
-        print(' - Flash emul_efuse with pre-loaded efuses (FLASH_CRYPT_CNT 1 -> 0)')
-        # offset of this eFuse is taken from components/efuse/esp32/esp_efuse_table.csv
-        FLASH_CRYPT_CNT = 20
-        # Resets eFuse, which enables Flash encryption feature
-        dut.serial.erase_field_on_emul_efuse([FLASH_CRYPT_CNT])
-    elif dut.app.target == 'esp32c2':
-        FLASH_CRYPT_CNT = 39
-        dut.serial.erase_field_on_emul_efuse([FLASH_CRYPT_CNT])
+        CRYPT_CNT_EFUSE_NAME = 'FLASH_CRYPT_CNT'
     else:
-        # offset of this eFuse is taken from components/efuse/{target}/esp_efuse_table.csv
-        print(' - Flash emul_efuse with pre-loaded efuses (SPI_BOOT_CRYPT_CNT 1 -> 0)')
-        if dut.app.target == 'esp32c61':
-            SPI_BOOT_CRYPT_CNT = 55
-        else:
-            SPI_BOOT_CRYPT_CNT = 82
-        # Resets eFuse, which enables Flash encryption feature
-        dut.serial.erase_field_on_emul_efuse([SPI_BOOT_CRYPT_CNT])
+        CRYPT_CNT_EFUSE_NAME = 'SPI_BOOT_CRYPT_CNT'
+    print(f' - Flash emul_efuse with pre-loaded efuses ({CRYPT_CNT_EFUSE_NAME} 1 -> 0)')
+    # Resets eFuse, which enables Flash encryption feature
+    dut.serial.erase_field_on_emul_efuse_by_name([CRYPT_CNT_EFUSE_NAME])
 
     print(' - Start app (flash partition_table and app)')
     dut.serial.write_flash_no_enc()
@@ -350,10 +339,8 @@ def test_examples_efuse_with_virt_secure_boot_v1_pre_loaded(dut: Dut) -> None:
     dut.expect('example: Done')
 
     print(' - Flash emul_efuse with pre-loaded efuses (ABS_DONE_0 1 -> 0)')
-    # offset of this eFuse is taken from components/efuse/esp32/esp_efuse_table.csv
-    ABS_DONE_0 = 196
     # Resets eFuse, which enables Secure boot (V1) feature
-    dut.serial.erase_field_on_emul_efuse([ABS_DONE_0])
+    dut.serial.erase_field_on_emul_efuse_by_name(['ABS_DONE_0'])
 
     print(' - Start app (flash partition_table and app)')
     dut.serial.flash()
@@ -456,10 +443,8 @@ def test_examples_efuse_with_virt_secure_boot_v2(dut: Dut) -> None:
     dut.expect('example: Done')
 
     print(' - Flash emul_efuse with pre-loaded efuses (ABS_DONE_1 1 -> 0)')
-    # offset of this eFuse is taken from components/efuse/esp32/esp_efuse_table.csv
-    ABS_DONE_1 = 197
     # Resets eFuse, which enables Secure boot (V2) feature
-    dut.serial.erase_field_on_emul_efuse([ABS_DONE_1])
+    dut.serial.erase_field_on_emul_efuse_by_name(['ABS_DONE_1'])
 
     print(' - Start app (flash partition_table and app)')
     dut.serial.flash()
@@ -521,10 +506,8 @@ def test_examples_efuse_with_virt_secure_boot_v2_pre_loaded(dut: Dut) -> None:
     dut.expect('example: Done')
 
     print(' - Flash emul_efuse with pre-loaded efuses (ABS_DONE_1 1 -> 0)')
-    # offset of this eFuse is taken from components/efuse/esp32/esp_efuse_table.csv
-    ABS_DONE_1 = 197
     # Resets eFuse, which enables Secure boot (V2) feature
-    dut.serial.erase_field_on_emul_efuse([ABS_DONE_1])
+    dut.serial.erase_field_on_emul_efuse_by_name(['ABS_DONE_1'])
 
     print(' - Start app (flash partition_table and app)')
     dut.serial.flash()
@@ -673,17 +656,12 @@ def test_example_efuse_with_virt_secure_boot_v2_esp32xx_pre_loaded(dut: Dut) ->
 
     print(' - Flash emul_efuse with pre-loaded efuses (SECURE_BOOT_EN 1 -> 0, SECURE_BOOT_KEY_REVOKE[0..2] -> 0)')
     # offsets of eFuses are taken from components/efuse/{target}/esp_efuse_table.csv
-    if dut.app.target == 'esp32c2':
-        SECURE_BOOT_EN = 53
-        dut.serial.erase_field_on_emul_efuse([SECURE_BOOT_EN])
+    # Resets eFuse, which enables Secure boot feature
+    # Resets eFuses, which control digest slots
+    if dut.app.sdkconfig.get('SOC_EFUSE_REVOKE_BOOT_KEY_DIGESTS'):
+        dut.serial.erase_field_on_emul_efuse_by_name(['SECURE_BOOT_EN', 'SECURE_BOOT_KEY_REVOKE0', 'SECURE_BOOT_KEY_REVOKE1', 'SECURE_BOOT_KEY_REVOKE2'])
     else:
-        SECURE_BOOT_EN = 116
-        SECURE_BOOT_KEY_REVOKE0 = 85
-        SECURE_BOOT_KEY_REVOKE1 = 86
-        SECURE_BOOT_KEY_REVOKE2 = 87
-        # Resets eFuse, which enables Secure boot feature
-        # Resets eFuses, which control digest slots
-        dut.serial.erase_field_on_emul_efuse([SECURE_BOOT_EN, SECURE_BOOT_KEY_REVOKE0, SECURE_BOOT_KEY_REVOKE1, SECURE_BOOT_KEY_REVOKE2])
+        dut.serial.erase_field_on_emul_efuse_by_name(['SECURE_BOOT_EN'])
 
     print(' - Start app (flash partition_table and app)')
     dut.serial.flash()