1# SPDX-FileCopyrightText: 2014-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
6import struct
7from typing import Dict
8
9from .esp32c3 import ESP32C3ROM
10from ..util import FatalError, NotImplementedInROMError
11
12from typing import List
13
14
15class ESP32H2BETA1ROM(ESP32C3ROM):
16    CHIP_NAME = "ESP32-H2(beta1)"
17    IMAGE_CHIP_ID = 10
18
19    IROM_MAP_START = 0x42000000
20    IROM_MAP_END = 0x42800000
21    DROM_MAP_START = 0x3C000000
22    DROM_MAP_END = 0x3C800000
23
24    SPI_REG_BASE = 0x60002000
25    SPI_USR_OFFS = 0x18
26    SPI_USR1_OFFS = 0x1C
27    SPI_USR2_OFFS = 0x20
28    SPI_MOSI_DLEN_OFFS = 0x24
29    SPI_MISO_DLEN_OFFS = 0x28
30    SPI_W0_OFFS = 0x58
31
32    BOOTLOADER_FLASH_OFFSET = 0x0
33
34    CHIP_DETECT_MAGIC_VALUE = [0xCA26CC22]
35
36    UART_DATE_REG_ADDR = 0x60000000 + 0x7C
37
38    EFUSE_BASE = 0x6001A000
39    EFUSE_BLOCK1_ADDR = EFUSE_BASE + 0x044
40    MAC_EFUSE_REG = EFUSE_BASE + 0x044
41
42    EFUSE_RD_REG_BASE = EFUSE_BASE + 0x030  # BLOCK0 read base address
43
44    EFUSE_PURPOSE_KEY0_REG = EFUSE_BASE + 0x34
45    EFUSE_PURPOSE_KEY0_SHIFT = 24
46    EFUSE_PURPOSE_KEY1_REG = EFUSE_BASE + 0x34
47    EFUSE_PURPOSE_KEY1_SHIFT = 28
48    EFUSE_PURPOSE_KEY2_REG = EFUSE_BASE + 0x38
49    EFUSE_PURPOSE_KEY2_SHIFT = 0
50    EFUSE_PURPOSE_KEY3_REG = EFUSE_BASE + 0x38
51    EFUSE_PURPOSE_KEY3_SHIFT = 4
52    EFUSE_PURPOSE_KEY4_REG = EFUSE_BASE + 0x38
53    EFUSE_PURPOSE_KEY4_SHIFT = 8
54    EFUSE_PURPOSE_KEY5_REG = EFUSE_BASE + 0x38
55    EFUSE_PURPOSE_KEY5_SHIFT = 12
56
57    EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT_REG = EFUSE_RD_REG_BASE
58    EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT = 1 << 20
59
60    EFUSE_SPI_BOOT_CRYPT_CNT_REG = EFUSE_BASE + 0x034
61    EFUSE_SPI_BOOT_CRYPT_CNT_MASK = 0x7 << 18
62
63    EFUSE_SECURE_BOOT_EN_REG = EFUSE_BASE + 0x038
64    EFUSE_SECURE_BOOT_EN_MASK = 1 << 20
65
66    PURPOSE_VAL_XTS_AES128_KEY = 4
67
68    SUPPORTS_ENCRYPTED_FLASH = True
69
70    FLASH_ENCRYPTED_WRITE_ALIGN = 16
71
72    MEMORY_MAP: List = []
73
74    FLASH_FREQUENCY = {
75        "48m": 0xF,
76        "24m": 0x0,
77        "16m": 0x1,
78        "12m": 0x2,
79    }
80
81    EFUSE_MAX_KEY = 5
82    KEY_PURPOSES: Dict[int, str] = {
83        0: "USER/EMPTY",
84        1: "ECDSA_KEY",
85        2: "RESERVED",
86        4: "XTS_AES_128_KEY",
87        5: "HMAC_DOWN_ALL",
88        6: "HMAC_DOWN_JTAG",
89        7: "HMAC_DOWN_DIGITAL_SIGNATURE",
90        8: "HMAC_UP",
91        9: "SECURE_BOOT_DIGEST0",
92        10: "SECURE_BOOT_DIGEST1",
93        11: "SECURE_BOOT_DIGEST2",
94    }
95
96    def get_pkg_version(self):
97        num_word = 4
98        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 0) & 0x07
99
100    def get_minor_chip_version(self):
101        num_word = 3
102        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 18) & 0x07
103
104    def get_major_chip_version(self):
105        num_word = 3
106        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 21) & 0x03
107
108    def get_chip_description(self):
109        chip_name = {
110            0: "ESP32-H2",
111        }.get(self.get_pkg_version(), "unknown ESP32-H2")
112        major_rev = self.get_major_chip_version()
113        minor_rev = self.get_minor_chip_version()
114        return f"{chip_name} (revision v{major_rev}.{minor_rev})"
115
116    def get_chip_features(self):
117        return ["BLE", "IEEE802.15.4"]
118
119    def get_crystal_freq(self):
120        return 32
121
122    def override_vddsdio(self, new_voltage):
123        raise NotImplementedInROMError(
124            "VDD_SDIO overrides are not supported for ESP32-H2"
125        )
126
127    def read_mac(self, mac_type="BASE_MAC"):
128        """Read MAC from EFUSE region"""
129        if mac_type != "BASE_MAC":
130            return None
131        mac0 = self.read_reg(self.MAC_EFUSE_REG)
132        mac1 = self.read_reg(self.MAC_EFUSE_REG + 4)  # only bottom 16 bits are MAC
133        bitstring = struct.pack(">II", mac1, mac0)[2:]
134        return tuple(bitstring)
135
136    def get_flash_crypt_config(self):
137        return None  # doesn't exist on ESP32-H2
138
139    def get_key_block_purpose(self, key_block):
140        if key_block < 0 or key_block > self.EFUSE_MAX_KEY:
141            raise FatalError(
142                f"Valid key block numbers must be in range 0-{self.EFUSE_MAX_KEY}"
143            )
144
145        reg, shift = [
146            (self.EFUSE_PURPOSE_KEY0_REG, self.EFUSE_PURPOSE_KEY0_SHIFT),
147            (self.EFUSE_PURPOSE_KEY1_REG, self.EFUSE_PURPOSE_KEY1_SHIFT),
148            (self.EFUSE_PURPOSE_KEY2_REG, self.EFUSE_PURPOSE_KEY2_SHIFT),
149            (self.EFUSE_PURPOSE_KEY3_REG, self.EFUSE_PURPOSE_KEY3_SHIFT),
150            (self.EFUSE_PURPOSE_KEY4_REG, self.EFUSE_PURPOSE_KEY4_SHIFT),
151            (self.EFUSE_PURPOSE_KEY5_REG, self.EFUSE_PURPOSE_KEY5_SHIFT),
152        ][key_block]
153        return (self.read_reg(reg) >> shift) & 0xF
154
155    def is_flash_encryption_key_valid(self):
156        # Need to see an AES-128 key
157        purposes = [
158            self.get_key_block_purpose(b) for b in range(self.EFUSE_MAX_KEY + 1)
159        ]
160
161        return any(p == self.PURPOSE_VAL_XTS_AES128_KEY for p in purposes)
162
163    def _post_connect(self):
164        pass
165
166
167class ESP32H2BETA1StubLoader(ESP32H2BETA1ROM):
168    """Access class for ESP32H2BETA1 stub loader, runs on top of ROM.
169
170    (Basically the same as ESP32StubLoader, but different base class.
171    Can possibly be made into a mixin.)
172    """
173
174    FLASH_WRITE_SIZE = 0x4000  # matches MAX_WRITE_BLOCK in stub_loader.c
175    STATUS_BYTES_LENGTH = 2  # same as ESP8266, different to ESP32 ROM
176    IS_STUB = True
177
178    def __init__(self, rom_loader):
179        self.secure_download_mode = rom_loader.secure_download_mode
180        self._port = rom_loader._port
181        self._trace_enabled = rom_loader._trace_enabled
182        self.cache = rom_loader.cache
183        self.flush_input()  # resets _slip_reader
184
185
186ESP32H2BETA1ROM.STUB_CLASS = ESP32H2BETA1StubLoader
187