1# SPDX-FileCopyrightText: 2022 Fredrik Ahlberg, Angus Gratton,
2# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
3#
4# SPDX-License-Identifier: GPL-2.0-or-later
5
6from typing import Dict
7
8from .esp32c6 import ESP32C6ROM
9from ..util import FatalError
10
11
12class ESP32H2ROM(ESP32C6ROM):
13    CHIP_NAME = "ESP32-H2"
14    IMAGE_CHIP_ID = 16
15
16    # Magic value for ESP32H2
17    CHIP_DETECT_MAGIC_VALUE = [0xD7B73E80]
18
19    DR_REG_LP_WDT_BASE = 0x600B1C00
20    RTC_CNTL_WDTCONFIG0_REG = DR_REG_LP_WDT_BASE + 0x0  # LP_WDT_RWDT_CONFIG0_REG
21    RTC_CNTL_WDTWPROTECT_REG = DR_REG_LP_WDT_BASE + 0x001C  # LP_WDT_RWDT_WPROTECT_REG
22
23    RTC_CNTL_SWD_CONF_REG = DR_REG_LP_WDT_BASE + 0x0020  # LP_WDT_SWD_CONFIG_REG
24    RTC_CNTL_SWD_AUTO_FEED_EN = 1 << 18
25    RTC_CNTL_SWD_WPROTECT_REG = DR_REG_LP_WDT_BASE + 0x0024  # LP_WDT_SWD_WPROTECT_REG
26    RTC_CNTL_SWD_WKEY = 0x50D83AA1  # LP_WDT_SWD_WKEY, same as WDT key in this case
27
28    FLASH_FREQUENCY = {
29        "48m": 0xF,
30        "24m": 0x0,
31        "16m": 0x1,
32        "12m": 0x2,
33    }
34
35    UF2_FAMILY_ID = 0x332726F6
36
37    EFUSE_MAX_KEY = 5
38    KEY_PURPOSES: Dict[int, str] = {
39        0: "USER/EMPTY",
40        1: "ECDSA_KEY",
41        2: "XTS_AES_256_KEY_1",
42        3: "XTS_AES_256_KEY_2",
43        4: "XTS_AES_128_KEY",
44        5: "HMAC_DOWN_ALL",
45        6: "HMAC_DOWN_JTAG",
46        7: "HMAC_DOWN_DIGITAL_SIGNATURE",
47        8: "HMAC_UP",
48        9: "SECURE_BOOT_DIGEST0",
49        10: "SECURE_BOOT_DIGEST1",
50        11: "SECURE_BOOT_DIGEST2",
51    }
52
53    def get_pkg_version(self):
54        num_word = 4
55        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 0) & 0x07
56
57    def get_minor_chip_version(self):
58        num_word = 3
59        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 18) & 0x07
60
61    def get_major_chip_version(self):
62        num_word = 3
63        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 21) & 0x03
64
65    def get_chip_description(self):
66        chip_name = {
67            0: "ESP32-H2",
68        }.get(self.get_pkg_version(), "unknown ESP32-H2")
69        major_rev = self.get_major_chip_version()
70        minor_rev = self.get_minor_chip_version()
71        return f"{chip_name} (revision v{major_rev}.{minor_rev})"
72
73    def get_chip_features(self):
74        return ["BLE", "IEEE802.15.4"]
75
76    def get_crystal_freq(self):
77        # ESP32H2 XTAL is fixed to 32MHz
78        return 32
79
80    def check_spi_connection(self, spi_connection):
81        if not set(spi_connection).issubset(set(range(0, 28))):
82            raise FatalError("SPI Pin numbers must be in the range 0-27.")
83        if any([v for v in spi_connection if v in [26, 27]]):
84            print(
85                "WARNING: GPIO pins 26 and 27 are used by USB-Serial/JTAG, "
86                "consider using other pins for SPI flash connection."
87            )
88
89
90class ESP32H2StubLoader(ESP32H2ROM):
91    """Access class for ESP32H2 stub loader, runs on top of ROM.
92
93    (Basically the same as ESP32StubLoader, but different base class.
94    Can possibly be made into a mixin.)
95    """
96
97    FLASH_WRITE_SIZE = 0x4000  # matches MAX_WRITE_BLOCK in stub_loader.c
98    STATUS_BYTES_LENGTH = 2  # same as ESP8266, different to ESP32 ROM
99    IS_STUB = True
100
101    def __init__(self, rom_loader):
102        self.secure_download_mode = rom_loader.secure_download_mode
103        self._port = rom_loader._port
104        self._trace_enabled = rom_loader._trace_enabled
105        self.cache = rom_loader.cache
106        self.flush_input()  # resets _slip_reader
107
108
109ESP32H2ROM.STUB_CLASS = ESP32H2StubLoader
110