esptool 4.9.dev1__tar.gz → 4.9.dev3__tar.gz

{esptool-4.9.dev1/esptool.egg-info → esptool-4.9.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esptool
-Version: 4.9.dev1
+Version: 4.9.dev3
 Summary: A serial utility to communicate & flash code to Espressif chips.
 Author: Fredrik Ahlberg (themadinventor), Angus Gratton (projectgus), Espressif Systems
 License: GPLv2+

{esptool-4.9.dev1 → esptool-4.9.dev3}/esp_rfc2217_server/__init__.py

@@ -64,8 +64,7 @@ def main():
     level = (logging.WARNING, logging.INFO, logging.DEBUG, logging.NOTSET)[
         args.verbosity
     ]
-    logging.basicConfig(level=logging.INFO)
-    # logging.getLogger('root').setLevel(logging.INFO)
+    logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.INFO)
     logging.getLogger("rfc2217").setLevel(level)
 
     # connect to serial port
@@ -75,26 +74,42 @@ def main():
     ser.dtr = False
     ser.rts = False
 
-    logging.info(" RFC 2217 TCP/IP to Serial redirector - type Ctrl-C / BREAK to quit")
+    logging.info("RFC 2217 TCP/IP to Serial redirector - type Ctrl-C / BREAK to quit")
 
     try:
         ser.open()
     except serial.SerialException as e:
-        logging.error(" Could not open serial port {}: {}".format(ser.name, e))
+        logging.error(f"Could not open serial port {ser.name}: {e}")
         sys.exit(1)
 
-    logging.info(" Serving serial port: {}".format(ser.name))
+    logging.info(f"Serving serial port: {ser.name}")
     settings = ser.get_settings()
 
     srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
     srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
     srv.bind(("", args.localport))
     srv.listen(1)
-    logging.info(" TCP/IP port: {}".format(args.localport))
+    logging.info(f"TCP/IP port: {args.localport}")
+
+    host_ip = socket.gethostbyname(socket.gethostname())
+    wait_msg = f"Waiting for connection ... use the 'rfc2217://{host_ip}:{args.localport}?ign_set_control' as a PORT"
+    logging.info(wait_msg)
+
     while True:
+        srv.settimeout(5)
+        client_socket = None
+        try:
+            while client_socket is None:
+                try:
+                    client_socket, addr = srv.accept()
+                except TimeoutError:
+                    print(".", end="", flush=True)
+        except KeyboardInterrupt:
+            print("")  # resetting inline print
+            logging.info("Exited with keyboard interrupt")
+            break
         try:
-            client_socket, addr = srv.accept()
-            logging.info("Connected by {}:{}".format(addr[0], addr[1]))
+            logging.info(f"Connected by {addr[0]}:{addr[1]}")
             client_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
             ser.rts = True
             ser.dtr = True

{esptool-4.9.dev1 → esptool-4.9.dev3}/espefuse/__init__.py

@@ -17,6 +17,7 @@ import espefuse.efuse.esp32c5beta3 as esp32c5beta3_efuse
 import espefuse.efuse.esp32c6 as esp32c6_efuse
 import espefuse.efuse.esp32c61 as esp32c61_efuse
 import espefuse.efuse.esp32h2 as esp32h2_efuse
+import espefuse.efuse.esp32h21 as esp32h21_efuse
 import espefuse.efuse.esp32h2beta1 as esp32h2beta1_efuse
 import espefuse.efuse.esp32p4 as esp32p4_efuse
 import espefuse.efuse.esp32s2 as esp32s2_efuse
@@ -61,6 +62,7 @@ SUPPORTED_CHIPS = {
         "ESP32-C5(beta3)", esp32c5beta3_efuse, esptool.targets.ESP32C5BETA3ROM
     ),
     "esp32h2": DefChip("ESP32-H2", esp32h2_efuse, esptool.targets.ESP32H2ROM),
+    "esp32h21": DefChip("ESP32-H21", esp32h21_efuse, esptool.targets.ESP32H21ROM),
     "esp32p4": DefChip("ESP32-P4", esp32p4_efuse, esptool.targets.ESP32P4ROM),
     "esp32h2beta1": DefChip(
         "ESP32-H2(beta1)", esp32h2beta1_efuse, esptool.targets.ESP32H2BETA1ROM

esptool-4.9.dev3/espefuse/efuse/esp32h21/emulate_efuse_controller.py

@@ -0,0 +1,92 @@
+# This file describes eFuses controller for ESP32-H21 chip
+#
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import reedsolo
+
+from .mem_definition import EfuseDefineBlocks, EfuseDefineFields, EfuseDefineRegisters
+from ..emulate_efuse_controller_base import EmulateEfuseControllerBase, FatalError
+
+
+class EmulateEfuseController(EmulateEfuseControllerBase):
+    """The class for virtual efuse operation. Using for HOST_TEST."""
+
+    CHIP_NAME = "ESP32-H21"
+    mem = None
+    debug = False
+
+    def __init__(self, efuse_file=None, debug=False):
+        self.Blocks = EfuseDefineBlocks
+        self.Fields = EfuseDefineFields(None)
+        self.REGS = EfuseDefineRegisters
+        super(EmulateEfuseController, self).__init__(efuse_file, debug)
+        self.write_reg(self.REGS.EFUSE_CMD_REG, 0)
+
+    """ esptool method start >>"""
+
+    def get_major_chip_version(self):
+        return 0
+
+    def get_minor_chip_version(self):
+        return 0
+
+    def get_crystal_freq(self):
+        return 32  # MHz
+
+    def get_security_info(self):
+        return {
+            "flags": 0,
+            "flash_crypt_cnt": 0,
+            "key_purposes": 0,
+            "chip_id": 0,
+            "api_version": 0,
+        }
+
+    """ << esptool method end """
+
+    def handle_writing_event(self, addr, value):
+        if addr == self.REGS.EFUSE_CMD_REG:
+            if value & self.REGS.EFUSE_PGM_CMD:
+                self.copy_blocks_wr_regs_to_rd_regs(updated_block=(value >> 2) & 0xF)
+                self.clean_blocks_wr_regs()
+                self.check_rd_protection_area()
+                self.write_reg(addr, 0)
+                self.write_reg(self.REGS.EFUSE_CMD_REG, 0)
+            elif value == self.REGS.EFUSE_READ_CMD:
+                self.write_reg(addr, 0)
+                self.write_reg(self.REGS.EFUSE_CMD_REG, 0)
+                self.save_to_file()
+
+    def get_bitlen_of_block(self, blk, wr=False):
+        if blk.id == 0:
+            if wr:
+                return 32 * 8
+            else:
+                return 32 * blk.len
+        else:
+            if wr:
+                rs_coding = 32 * 3
+                return 32 * 8 + rs_coding
+            else:
+                return 32 * blk.len
+
+    def handle_coding_scheme(self, blk, data):
+        if blk.id != 0:
+            # CODING_SCHEME RS applied only for all blocks except BLK0.
+            coded_bytes = 12
+            data.pos = coded_bytes * 8
+            plain_data = data.readlist("32*uint:8")[::-1]
+            # takes 32 bytes
+            # apply RS encoding
+            rs = reedsolo.RSCodec(coded_bytes)
+            # 32 byte of data + 12 bytes RS
+            calc_encoded_data = list(rs.encode([x for x in plain_data]))
+            data.pos = 0
+            if calc_encoded_data != data.readlist("44*uint:8")[::-1]:
+                raise FatalError("Error in coding scheme data")
+            data = data[coded_bytes * 8 :]
+        if blk.len < 8:
+            data = data[(8 - blk.len) * 32 :]
+        return data

esptool-4.9.dev3/espefuse/efuse/esp32h21/fields.py

@@ -0,0 +1,449 @@
+# This file describes eFuses for ESP32-H21 chip
+#
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import binascii
+import struct
+import sys
+import time
+
+from bitstring import BitArray
+
+import esptool
+
+import reedsolo
+
+from .mem_definition import EfuseDefineBlocks, EfuseDefineFields, EfuseDefineRegisters
+from .. import base_fields
+from .. import util
+
+
+class EfuseBlock(base_fields.EfuseBlockBase):
+    def len_of_burn_unit(self):
+        # The writing register window is 8 registers for any blocks.
+        # len in bytes
+        return 8 * 4
+
+    def __init__(self, parent, param, skip_read=False):
+        parent.read_coding_scheme()
+        super(EfuseBlock, self).__init__(parent, param, skip_read=skip_read)
+
+    def apply_coding_scheme(self):
+        data = self.get_raw(from_read=False)[::-1]
+        if len(data) < self.len_of_burn_unit():
+            add_empty_bytes = self.len_of_burn_unit() - len(data)
+            data = data + (b"\x00" * add_empty_bytes)
+        if self.get_coding_scheme() == self.parent.REGS.CODING_SCHEME_RS:
+            # takes 32 bytes
+            # apply RS encoding
+            rs = reedsolo.RSCodec(12)
+            # 32 byte of data + 12 bytes RS
+            encoded_data = rs.encode([x for x in data])
+            words = struct.unpack("<" + "I" * 11, encoded_data)
+            # returns 11 words (8 words of data + 3 words of RS coding)
+        else:
+            # takes 32 bytes
+            words = struct.unpack("<" + ("I" * (len(data) // 4)), data)
+            # returns 8 words
+        return words
+
+
+class EspEfuses(base_fields.EspEfusesBase):
+    """
+    Wrapper object to manage the efuse fields in a connected ESP bootloader
+    """
+
+    debug = False
+    do_not_confirm = False
+
+    def __init__(
+        self,
+        esp,
+        skip_connect=False,
+        debug=False,
+        do_not_confirm=False,
+        extend_efuse_table=None,
+    ):
+        self.Blocks = EfuseDefineBlocks()
+        self.Fields = EfuseDefineFields(extend_efuse_table)
+        self.REGS = EfuseDefineRegisters
+        self.BURN_BLOCK_DATA_NAMES = self.Blocks.get_burn_block_data_names()
+        self.BLOCKS_FOR_KEYS = self.Blocks.get_blocks_for_keys()
+        self._esp = esp
+        self.debug = debug
+        self.do_not_confirm = do_not_confirm
+        if esp.CHIP_NAME != "ESP32-H21":
+            raise esptool.FatalError(
+                "Expected the 'esp' param for ESP32-H21 chip but got for '%s'."
+                % (esp.CHIP_NAME)
+            )
+        if not skip_connect:
+            flags = self._esp.get_security_info()["flags"]
+            GET_SECURITY_INFO_FLAG_SECURE_DOWNLOAD_ENABLE = 1 << 2
+            if flags & GET_SECURITY_INFO_FLAG_SECURE_DOWNLOAD_ENABLE:
+                raise esptool.FatalError(
+                    "Secure Download Mode is enabled. The tool can not read eFuses."
+                )
+        self.blocks = [
+            EfuseBlock(self, self.Blocks.get(block), skip_read=skip_connect)
+            for block in self.Blocks.BLOCKS
+        ]
+        if not skip_connect:
+            self.get_coding_scheme_warnings()
+        self.efuses = [EfuseField.convert(self, efuse) for efuse in self.Fields.EFUSES]
+        self.efuses += [
+            EfuseField.convert(self, efuse) for efuse in self.Fields.KEYBLOCKS
+        ]
+        if skip_connect:
+            self.efuses += [
+                EfuseField.convert(self, efuse)
+                for efuse in self.Fields.BLOCK2_CALIBRATION_EFUSES
+            ]
+        else:
+            if self.get_block_version() >= 2:
+                self.efuses += [
+                    EfuseField.convert(self, efuse)
+                    for efuse in self.Fields.BLOCK2_CALIBRATION_EFUSES
+                ]
+            self.efuses += [
+                EfuseField.convert(self, efuse) for efuse in self.Fields.CALC
+            ]
+
+    def __getitem__(self, efuse_name):
+        """Return the efuse field with the given name"""
+        for e in self.efuses:
+            if efuse_name == e.name or any(x == efuse_name for x in e.alt_names):
+                return e
+        new_fields = False
+        for efuse in self.Fields.BLOCK2_CALIBRATION_EFUSES:
+            if efuse.name == efuse_name or any(
+                x == efuse_name for x in efuse.alt_names
+            ):
+                self.efuses += [
+                    EfuseField.convert(self, efuse)
+                    for efuse in self.Fields.BLOCK2_CALIBRATION_EFUSES
+                ]
+                new_fields = True
+        if new_fields:
+            for e in self.efuses:
+                if efuse_name == e.name or any(x == efuse_name for x in e.alt_names):
+                    return e
+        raise KeyError
+
+    def read_coding_scheme(self):
+        self.coding_scheme = self.REGS.CODING_SCHEME_RS
+
+    def print_status_regs(self):
+        print("")
+        self.blocks[0].print_block(self.blocks[0].err_bitarray, "err__regs", debug=True)
+        print(
+            "{:27} 0x{:08x}".format(
+                "EFUSE_RD_RS_ERR0_REG", self.read_reg(self.REGS.EFUSE_RD_RS_ERR0_REG)
+            )
+        )
+        print(
+            "{:27} 0x{:08x}".format(
+                "EFUSE_RD_RS_ERR1_REG", self.read_reg(self.REGS.EFUSE_RD_RS_ERR1_REG)
+            )
+        )
+
+    def efuse_controller_setup(self):
+        self.set_efuse_timing()
+        self.clear_pgm_registers()
+        self.wait_efuse_idle()
+
+    def write_efuses(self, block):
+        self.efuse_program(block)
+        return self.get_coding_scheme_warnings(silent=True)
+
+    def clear_pgm_registers(self):
+        self.wait_efuse_idle()
+        for r in range(
+            self.REGS.EFUSE_PGM_DATA0_REG, self.REGS.EFUSE_PGM_DATA0_REG + 32, 4
+        ):
+            self.write_reg(r, 0)
+
+    def wait_efuse_idle(self):
+        deadline = time.time() + self.REGS.EFUSE_BURN_TIMEOUT
+        while time.time() < deadline:
+            cmds = self.REGS.EFUSE_PGM_CMD | self.REGS.EFUSE_READ_CMD
+            if self.read_reg(self.REGS.EFUSE_CMD_REG) & cmds == 0:
+                if self.read_reg(self.REGS.EFUSE_CMD_REG) & cmds == 0:
+                    # Due to a hardware error, we have to read READ_CMD again
+                    # to make sure the efuse clock is normal.
+                    # For PGM_CMD it is not necessary.
+                    return
+        raise esptool.FatalError(
+            "Timed out waiting for Efuse controller command to complete"
+        )
+
+    def efuse_program(self, block):
+        self.wait_efuse_idle()
+        self.write_reg(self.REGS.EFUSE_CONF_REG, self.REGS.EFUSE_WRITE_OP_CODE)
+        self.write_reg(self.REGS.EFUSE_CMD_REG, self.REGS.EFUSE_PGM_CMD | (block << 2))
+        self.wait_efuse_idle()
+        self.clear_pgm_registers()
+        self.efuse_read()
+
+    def efuse_read(self):
+        self.wait_efuse_idle()
+        self.write_reg(self.REGS.EFUSE_CONF_REG, self.REGS.EFUSE_READ_OP_CODE)
+        # need to add a delay after triggering EFUSE_READ_CMD, as ROM loader checks some
+        # efuse registers after each command is completed
+        # if ENABLE_SECURITY_DOWNLOAD or DIS_DOWNLOAD_MODE is enabled by the current cmd, then we need to try to reconnect to the chip.
+        try:
+            self.write_reg(
+                self.REGS.EFUSE_CMD_REG, self.REGS.EFUSE_READ_CMD, delay_after_us=1000
+            )
+            self.wait_efuse_idle()
+        except esptool.FatalError:
+            secure_download_mode_before = self._esp.secure_download_mode
+
+            try:
+                self._esp = self.reconnect_chip(self._esp)
+            except esptool.FatalError:
+                print("Can not re-connect to the chip")
+                if not self["DIS_DOWNLOAD_MODE"].get() and self[
+                    "DIS_DOWNLOAD_MODE"
+                ].get(from_read=False):
+                    print(
+                        "This is the correct behavior as we are actually burning "
+                        "DIS_DOWNLOAD_MODE which disables the connection to the chip"
+                    )
+                    print("DIS_DOWNLOAD_MODE is enabled")
+                    print("Successful")
+                    sys.exit(0)  # finish without errors
+                raise
+
+            print("Established a connection with the chip")
+            if self._esp.secure_download_mode and not secure_download_mode_before:
+                print("Secure download mode is enabled")
+                if not self["ENABLE_SECURITY_DOWNLOAD"].get() and self[
+                    "ENABLE_SECURITY_DOWNLOAD"
+                ].get(from_read=False):
+                    print(
+                        "espefuse tool can not continue to work in Secure download mode"
+                    )
+                    print("ENABLE_SECURITY_DOWNLOAD is enabled")
+                    print("Successful")
+                    sys.exit(0)  # finish without errors
+            raise
+
+    def set_efuse_timing(self):
+        """Set timing registers for burning efuses"""
+        # Configure clock
+        apb_freq = self.get_crystal_freq()
+        # Based on `CONFIG_SOC_XTAL_SUPPORT_32M=y` for this target from ESP-IDF configuration
+        if apb_freq != 32:
+            raise esptool.FatalError(
+                "The eFuse supports only xtal=32M (xtal was %d)" % apb_freq
+            )
+        # TODO: [ESP32H21] IDF-11506
+
+    def get_coding_scheme_warnings(self, silent=False):
+        """Check if the coding scheme has detected any errors."""
+        old_addr_reg = 0
+        reg_value = 0
+        ret_fail = False
+        for block in self.blocks:
+            if block.id == 0:
+                words = [
+                    self.read_reg(self.REGS.EFUSE_RD_REPEAT_ERR0_REG + offs * 4)
+                    for offs in range(5)
+                ]
+                block.err_bitarray.pos = 0
+                for word in reversed(words):
+                    block.err_bitarray.overwrite(BitArray("uint:32=%d" % word))
+                block.num_errors = block.err_bitarray.count(True)
+                block.fail = block.num_errors != 0
+            else:
+                addr_reg, err_num_mask, err_num_offs, fail_bit = self.REGS.BLOCK_ERRORS[
+                    block.id
+                ]
+                if err_num_mask is None or err_num_offs is None or fail_bit is None:
+                    continue
+                if addr_reg != old_addr_reg:
+                    old_addr_reg = addr_reg
+                    reg_value = self.read_reg(addr_reg)
+                block.fail = reg_value & (1 << fail_bit) != 0
+                block.num_errors = (reg_value >> err_num_offs) & err_num_mask
+            ret_fail |= block.fail
+            if not silent and (block.fail or block.num_errors):
+                print(
+                    "Error(s) in BLOCK%d [ERRORS:%d FAIL:%d]"
+                    % (block.id, block.num_errors, block.fail)
+                )
+        if (self.debug or ret_fail) and not silent:
+            self.print_status_regs()
+        return ret_fail
+
+    def summary(self):
+        # TODO add support set_flash_voltage - "Flash voltage (VDD_SPI)"
+        return ""
+
+
+class EfuseField(base_fields.EfuseFieldBase):
+    @staticmethod
+    def convert(parent, efuse):
+        return {
+            "mac": EfuseMacField,
+            "keypurpose": EfuseKeyPurposeField,
+            "t_sensor": EfuseTempSensor,
+            "adc_tp": EfuseAdcPointCalibration,
+            "wafer": EfuseWafer,
+        }.get(efuse.class_type, EfuseField)(parent, efuse)
+
+
+class EfuseWafer(EfuseField):
+    def get(self, from_read=True):
+        # TODO: [ESP32H21] IDF-11506
+        return 0
+
+    def save(self, new_value):
+        raise esptool.FatalError("Burning %s is not supported" % self.name)
+
+
+class EfuseTempSensor(EfuseField):
+    def get(self, from_read=True):
+        value = self.get_bitstring(from_read)
+        sig = -1 if value[0] else 1
+        return sig * value[1:].uint * 0.1
+
+
+class EfuseAdcPointCalibration(EfuseField):
+    def get(self, from_read=True):
+        STEP_SIZE = 4
+        value = self.get_bitstring(from_read)
+        sig = -1 if value[0] else 1
+        return sig * value[1:].uint * STEP_SIZE
+
+
+class EfuseMacField(EfuseField):
+    def check_format(self, new_value_str):
+        if new_value_str is None:
+            raise esptool.FatalError(
+                "Required MAC Address in AA:CD:EF:01:02:03 format!"
+            )
+        num_bytes = 8 if self.name == "MAC_EUI64" else 6
+        if new_value_str.count(":") != num_bytes - 1:
+            raise esptool.FatalError(
+                f"MAC Address needs to be a {num_bytes}-byte hexadecimal format "
+                "separated by colons (:)!"
+            )
+        hexad = new_value_str.replace(":", "")
+        hexad = hexad.split(" ", 1)[0] if self.is_field_calculated() else hexad
+        if len(hexad) != num_bytes * 2:
+            raise esptool.FatalError(
+                f"MAC Address needs to be a {num_bytes}-byte hexadecimal number "
+                f"({num_bytes * 2} hexadecimal characters)!"
+            )
+        # order of bytearray = b'\xaa\xcd\xef\x01\x02\x03',
+        bindata = binascii.unhexlify(hexad)
+
+        if not self.is_field_calculated():
+            # unicast address check according to
+            # https://tools.ietf.org/html/rfc7042#section-2.1
+            if esptool.util.byte(bindata, 0) & 0x01:
+                raise esptool.FatalError("Custom MAC must be a unicast MAC!")
+        return bindata
+
+    def check(self):
+        errs, fail = self.parent.get_block_errors(self.block)
+        if errs != 0 or fail:
+            output = "Block%d has ERRORS:%d FAIL:%d" % (self.block, errs, fail)
+        else:
+            output = "OK"
+        return "(" + output + ")"
+
+    def get(self, from_read=True):
+        if self.name == "CUSTOM_MAC":
+            mac = self.get_raw(from_read)[::-1]
+        elif self.name == "MAC":
+            mac = self.get_raw(from_read)
+        elif self.name == "MAC_EUI64":
+            mac = self.parent["MAC"].get_bitstring(from_read).copy()
+            mac_ext = self.parent["MAC_EXT"].get_bitstring(from_read)
+            mac.insert(mac_ext, 24)
+            mac = mac.bytes
+        else:
+            mac = self.get_raw(from_read)
+        return "%s %s" % (util.hexify(mac, ":"), self.check())
+
+    def save(self, new_value):
+        def print_field(e, new_value):
+            print(
+                "    - '{}' ({}) {} -> {}".format(
+                    e.name, e.description, e.get_bitstring(), new_value
+                )
+            )
+
+        if self.name == "CUSTOM_MAC":
+            bitarray_mac = self.convert_to_bitstring(new_value)
+            print_field(self, bitarray_mac)
+            super(EfuseMacField, self).save(new_value)
+        else:
+            # Writing the BLOCK1 (MAC_SPI_8M_0) default MAC is not possible,
+            # as it's written in the factory.
+            raise esptool.FatalError(f"Burning {self.name} is not supported")
+
+
+# fmt: off
+class EfuseKeyPurposeField(EfuseField):
+    KEY_PURPOSES = [
+        ("USER",                         0,  None,       None,      "no_need_rd_protect"),   # User purposes (software-only use)
+        ("ECDSA_KEY",                    1,  None,       "Reverse", "need_rd_protect"),      # ECDSA key
+        ("RESERVED",                     2,  None,       None,      "no_need_rd_protect"),   # Reserved
+        ("XTS_AES_128_KEY",              4,  None,       "Reverse", "need_rd_protect"),      # XTS_AES_128_KEY (flash/PSRAM encryption)
+        ("HMAC_DOWN_ALL",                5,  None,       None,      "need_rd_protect"),      # HMAC Downstream mode
+        ("HMAC_DOWN_JTAG",               6,  None,       None,      "need_rd_protect"),      # JTAG soft enable key (uses HMAC Downstream mode)
+        ("HMAC_DOWN_DIGITAL_SIGNATURE",  7,  None,       None,      "need_rd_protect"),      # Digital Signature peripheral key (uses HMAC Downstream mode)
+        ("HMAC_UP",                      8,  None,       None,      "need_rd_protect"),      # HMAC Upstream mode
+        ("SECURE_BOOT_DIGEST0",          9,  "DIGEST",   None,      "no_need_rd_protect"),   # SECURE_BOOT_DIGEST0 (Secure Boot key digest)
+        ("SECURE_BOOT_DIGEST1",          10, "DIGEST",   None,      "no_need_rd_protect"),   # SECURE_BOOT_DIGEST1 (Secure Boot key digest)
+        ("SECURE_BOOT_DIGEST2",          11, "DIGEST",   None,      "no_need_rd_protect"),   # SECURE_BOOT_DIGEST2 (Secure Boot key digest)
+    ]
+# fmt: on
+    KEY_PURPOSES_NAME = [name[0] for name in KEY_PURPOSES]
+    DIGEST_KEY_PURPOSES = [name[0] for name in KEY_PURPOSES if name[2] == "DIGEST"]
+
+    def check_format(self, new_value_str):
+        # str convert to int: "XTS_AES_128_KEY" - > str(4)
+        # if int: 4 -> str(4)
+        raw_val = new_value_str
+        for purpose_name in self.KEY_PURPOSES:
+            if purpose_name[0] == new_value_str:
+                raw_val = str(purpose_name[1])
+                break
+        if raw_val.isdigit():
+            if int(raw_val) not in [p[1] for p in self.KEY_PURPOSES if p[1] > 0]:
+                raise esptool.FatalError("'%s' can not be set (value out of range)" % raw_val)
+        else:
+            raise esptool.FatalError("'%s' unknown name" % raw_val)
+        return raw_val
+
+    def need_reverse(self, new_key_purpose):
+        for key in self.KEY_PURPOSES:
+            if key[0] == new_key_purpose:
+                return key[3] == "Reverse"
+
+    def need_rd_protect(self, new_key_purpose):
+        for key in self.KEY_PURPOSES:
+            if key[0] == new_key_purpose:
+                return key[4] == "need_rd_protect"
+
+    def get(self, from_read=True):
+        for p in self.KEY_PURPOSES:
+            if p[1] == self.get_raw(from_read):
+                return p[0]
+        return "FORBIDDEN_STATE"
+
+    def get_name(self, raw_val):
+        for key in self.KEY_PURPOSES:
+            if key[1] == raw_val:
+                return key[0]
+
+    def save(self, new_value):
+        raw_val = int(self.check_format(str(new_value)))
+        return super(EfuseKeyPurposeField, self).save(raw_val)