1# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
2#
3# SPDX-License-Identifier: GPL-2.0-or-later
4
5import struct
6from typing import Dict
7
8from .esp32c6 import ESP32C6ROM
9
10
11class ESP32C61ROM(ESP32C6ROM):
12    CHIP_NAME = "ESP32-C61"
13    IMAGE_CHIP_ID = 20
14
15    # Magic value for ESP32C61
16    CHIP_DETECT_MAGIC_VALUE = [0x33F0206F, 0x2421606F]
17
18    UART_DATE_REG_ADDR = 0x60000000 + 0x7C
19
20    EFUSE_BASE = 0x600B4800
21    EFUSE_BLOCK1_ADDR = EFUSE_BASE + 0x044
22    MAC_EFUSE_REG = EFUSE_BASE + 0x044
23
24    EFUSE_RD_REG_BASE = EFUSE_BASE + 0x030  # BLOCK0 read base address
25
26    EFUSE_PURPOSE_KEY0_REG = EFUSE_BASE + 0x34
27    EFUSE_PURPOSE_KEY0_SHIFT = 0
28    EFUSE_PURPOSE_KEY1_REG = EFUSE_BASE + 0x34
29    EFUSE_PURPOSE_KEY1_SHIFT = 4
30    EFUSE_PURPOSE_KEY2_REG = EFUSE_BASE + 0x34
31    EFUSE_PURPOSE_KEY2_SHIFT = 8
32    EFUSE_PURPOSE_KEY3_REG = EFUSE_BASE + 0x34
33    EFUSE_PURPOSE_KEY3_SHIFT = 12
34    EFUSE_PURPOSE_KEY4_REG = EFUSE_BASE + 0x34
35    EFUSE_PURPOSE_KEY4_SHIFT = 16
36    EFUSE_PURPOSE_KEY5_REG = EFUSE_BASE + 0x34
37    EFUSE_PURPOSE_KEY5_SHIFT = 20
38
39    EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT_REG = EFUSE_RD_REG_BASE
40    EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT = 1 << 20
41
42    EFUSE_SPI_BOOT_CRYPT_CNT_REG = EFUSE_BASE + 0x030
43    EFUSE_SPI_BOOT_CRYPT_CNT_MASK = 0x7 << 23
44
45    EFUSE_SECURE_BOOT_EN_REG = EFUSE_BASE + 0x034
46    EFUSE_SECURE_BOOT_EN_MASK = 1 << 26
47
48    FLASH_FREQUENCY = {
49        "80m": 0xF,
50        "40m": 0x0,
51        "20m": 0x2,
52    }
53
54    MEMORY_MAP = [
55        [0x00000000, 0x00010000, "PADDING"],
56        [0x41800000, 0x42000000, "DROM"],
57        [0x40800000, 0x40860000, "DRAM"],
58        [0x40800000, 0x40860000, "BYTE_ACCESSIBLE"],
59        [0x4004AC00, 0x40050000, "DROM_MASK"],
60        [0x40000000, 0x4004AC00, "IROM_MASK"],
61        [0x41000000, 0x41800000, "IROM"],
62        [0x40800000, 0x40860000, "IRAM"],
63        [0x50000000, 0x50004000, "RTC_IRAM"],
64        [0x50000000, 0x50004000, "RTC_DRAM"],
65        [0x600FE000, 0x60100000, "MEM_INTERNAL2"],
66    ]
67
68    UF2_FAMILY_ID = 0x77D850C4
69
70    EFUSE_MAX_KEY = 5
71    KEY_PURPOSES: Dict[int, str] = {
72        0: "USER/EMPTY",
73        1: "ECDSA_KEY",
74        2: "XTS_AES_256_KEY_1",
75        3: "XTS_AES_256_KEY_2",
76        4: "XTS_AES_128_KEY",
77        5: "HMAC_DOWN_ALL",
78        6: "HMAC_DOWN_JTAG",
79        7: "HMAC_DOWN_DIGITAL_SIGNATURE",
80        8: "HMAC_UP",
81        9: "SECURE_BOOT_DIGEST0",
82        10: "SECURE_BOOT_DIGEST1",
83        11: "SECURE_BOOT_DIGEST2",
84        12: "KM_INIT_KEY",
85        13: "XTS_AES_256_KEY_1_PSRAM",
86        14: "XTS_AES_256_KEY_2_PSRAM",
87        15: "XTS_AES_128_KEY_PSRAM",
88    }
89
90    def get_pkg_version(self):
91        num_word = 2
92        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 26) & 0x07
93
94    def get_minor_chip_version(self):
95        num_word = 2
96        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 0) & 0x0F
97
98    def get_major_chip_version(self):
99        num_word = 2
100        return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 4) & 0x03
101
102    def get_chip_description(self):
103        chip_name = {
104            0: "ESP32-C61",
105        }.get(self.get_pkg_version(), "unknown ESP32-C61")
106        major_rev = self.get_major_chip_version()
107        minor_rev = self.get_minor_chip_version()
108        return f"{chip_name} (revision v{major_rev}.{minor_rev})"
109
110    def get_chip_features(self):
111        return ["WiFi 6", "BT 5"]
112
113    def read_mac(self, mac_type="BASE_MAC"):
114        """Read MAC from EFUSE region"""
115        mac0 = self.read_reg(self.MAC_EFUSE_REG)
116        mac1 = self.read_reg(self.MAC_EFUSE_REG + 4)  # only bottom 16 bits are MAC
117        base_mac = struct.pack(">II", mac1, mac0)[2:]
118        # BASE MAC: 60:55:f9:f7:2c:a2
119        macs = {
120            "BASE_MAC": tuple(base_mac),
121        }
122        return macs.get(mac_type, None)
123
124
125class ESP32C61StubLoader(ESP32C61ROM):
126    """Access class for ESP32C61 stub loader, runs on top of ROM.
127
128    (Basically the same as ESP32StubLoader, but different base class.
129    Can possibly be made into a mixin.)
130    """
131
132    FLASH_WRITE_SIZE = 0x4000  # matches MAX_WRITE_BLOCK in stub_loader.c
133    STATUS_BYTES_LENGTH = 2  # same as ESP8266, different to ESP32 ROM
134    IS_STUB = True
135
136    def __init__(self, rom_loader):
137        self.secure_download_mode = rom_loader.secure_download_mode
138        self._port = rom_loader._port
139        self._trace_enabled = rom_loader._trace_enabled
140        self.cache = rom_loader.cache
141        self.flush_input()  # resets _slip_reader
142
143
144ESP32C61ROM.STUB_CLASS = ESP32C61StubLoader
145