191 lines
6.3 KiB
Python
191 lines
6.3 KiB
Python
# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
import struct
|
|
import time
|
|
from typing import Dict
|
|
|
|
from .esp32c6 import ESP32C6ROM
|
|
from ..loader import ESPLoader
|
|
from ..reset import HardReset
|
|
from ..util import FatalError
|
|
|
|
|
|
class ESP32C5ROM(ESP32C6ROM):
|
|
CHIP_NAME = "ESP32-C5"
|
|
IMAGE_CHIP_ID = 23
|
|
|
|
EFUSE_BASE = 0x600B4800
|
|
EFUSE_BLOCK1_ADDR = EFUSE_BASE + 0x044
|
|
MAC_EFUSE_REG = EFUSE_BASE + 0x044
|
|
|
|
EFUSE_RD_REG_BASE = EFUSE_BASE + 0x030 # BLOCK0 read base address
|
|
|
|
EFUSE_PURPOSE_KEY0_REG = EFUSE_BASE + 0x34
|
|
EFUSE_PURPOSE_KEY0_SHIFT = 24
|
|
EFUSE_PURPOSE_KEY1_REG = EFUSE_BASE + 0x34
|
|
EFUSE_PURPOSE_KEY1_SHIFT = 28
|
|
EFUSE_PURPOSE_KEY2_REG = EFUSE_BASE + 0x38
|
|
EFUSE_PURPOSE_KEY2_SHIFT = 0
|
|
EFUSE_PURPOSE_KEY3_REG = EFUSE_BASE + 0x38
|
|
EFUSE_PURPOSE_KEY3_SHIFT = 4
|
|
EFUSE_PURPOSE_KEY4_REG = EFUSE_BASE + 0x38
|
|
EFUSE_PURPOSE_KEY4_SHIFT = 8
|
|
EFUSE_PURPOSE_KEY5_REG = EFUSE_BASE + 0x38
|
|
EFUSE_PURPOSE_KEY5_SHIFT = 12
|
|
|
|
EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT_REG = EFUSE_RD_REG_BASE
|
|
EFUSE_DIS_DOWNLOAD_MANUAL_ENCRYPT = 1 << 20
|
|
|
|
EFUSE_SPI_BOOT_CRYPT_CNT_REG = EFUSE_BASE + 0x034
|
|
EFUSE_SPI_BOOT_CRYPT_CNT_MASK = 0x7 << 18
|
|
|
|
EFUSE_SECURE_BOOT_EN_REG = EFUSE_BASE + 0x038
|
|
EFUSE_SECURE_BOOT_EN_MASK = 1 << 20
|
|
|
|
IROM_MAP_START = 0x42000000
|
|
IROM_MAP_END = 0x42800000
|
|
DROM_MAP_START = 0x42800000
|
|
DROM_MAP_END = 0x43000000
|
|
|
|
PCR_SYSCLK_CONF_REG = 0x60096110
|
|
PCR_SYSCLK_XTAL_FREQ_V = 0x7F << 24
|
|
PCR_SYSCLK_XTAL_FREQ_S = 24
|
|
|
|
UARTDEV_BUF_NO = 0x4085F51C # Variable in ROM .bss which indicates the port in use
|
|
|
|
# Magic value for ESP32C5
|
|
CHIP_DETECT_MAGIC_VALUE = [0x1101406F]
|
|
|
|
FLASH_FREQUENCY = {
|
|
"80m": 0xF,
|
|
"40m": 0x0,
|
|
"20m": 0x2,
|
|
}
|
|
|
|
MEMORY_MAP = [
|
|
[0x00000000, 0x00010000, "PADDING"],
|
|
[0x42800000, 0x43000000, "DROM"],
|
|
[0x40800000, 0x40860000, "DRAM"],
|
|
[0x40800000, 0x40860000, "BYTE_ACCESSIBLE"],
|
|
[0x4003A000, 0x40040000, "DROM_MASK"],
|
|
[0x40000000, 0x4003A000, "IROM_MASK"],
|
|
[0x42000000, 0x42800000, "IROM"],
|
|
[0x40800000, 0x40860000, "IRAM"],
|
|
[0x50000000, 0x50004000, "RTC_IRAM"],
|
|
[0x50000000, 0x50004000, "RTC_DRAM"],
|
|
[0x600FE000, 0x60100000, "MEM_INTERNAL2"],
|
|
]
|
|
|
|
UF2_FAMILY_ID = 0xF71C0343
|
|
|
|
EFUSE_MAX_KEY = 5
|
|
KEY_PURPOSES: Dict[int, str] = {
|
|
0: "USER/EMPTY",
|
|
1: "ECDSA_KEY",
|
|
2: "XTS_AES_256_KEY_1",
|
|
3: "XTS_AES_256_KEY_2",
|
|
4: "XTS_AES_128_KEY",
|
|
5: "HMAC_DOWN_ALL",
|
|
6: "HMAC_DOWN_JTAG",
|
|
7: "HMAC_DOWN_DIGITAL_SIGNATURE",
|
|
8: "HMAC_UP",
|
|
9: "SECURE_BOOT_DIGEST0",
|
|
10: "SECURE_BOOT_DIGEST1",
|
|
11: "SECURE_BOOT_DIGEST2",
|
|
12: "KM_INIT_KEY",
|
|
}
|
|
|
|
def get_pkg_version(self):
|
|
num_word = 2
|
|
return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 26) & 0x07
|
|
|
|
def get_minor_chip_version(self):
|
|
num_word = 2
|
|
return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 0) & 0x0F
|
|
|
|
def get_major_chip_version(self):
|
|
num_word = 2
|
|
return (self.read_reg(self.EFUSE_BLOCK1_ADDR + (4 * num_word)) >> 4) & 0x03
|
|
|
|
def get_chip_description(self):
|
|
chip_name = {
|
|
0: "ESP32-C5",
|
|
}.get(self.get_pkg_version(), "unknown ESP32-C5")
|
|
major_rev = self.get_major_chip_version()
|
|
minor_rev = self.get_minor_chip_version()
|
|
return f"{chip_name} (revision v{major_rev}.{minor_rev})"
|
|
|
|
def get_crystal_freq(self):
|
|
# The crystal detection algorithm of ESP32/ESP8266
|
|
# works for ESP32-C5 as well.
|
|
return ESPLoader.get_crystal_freq(self)
|
|
|
|
def get_crystal_freq_rom_expect(self):
|
|
return (
|
|
self.read_reg(self.PCR_SYSCLK_CONF_REG) & self.PCR_SYSCLK_XTAL_FREQ_V
|
|
) >> self.PCR_SYSCLK_XTAL_FREQ_S
|
|
|
|
def hard_reset(self):
|
|
print("Hard resetting via RTS pin...")
|
|
HardReset(self._port, self.uses_usb_jtag_serial())()
|
|
|
|
def change_baud(self, baud):
|
|
if not self.IS_STUB:
|
|
crystal_freq_rom_expect = self.get_crystal_freq_rom_expect()
|
|
crystal_freq_detect = self.get_crystal_freq()
|
|
print(
|
|
f"ROM expects crystal freq: {crystal_freq_rom_expect} MHz, detected {crystal_freq_detect} MHz"
|
|
)
|
|
baud_rate = baud
|
|
# If detect the XTAL is 48MHz, but the ROM code expects it to be 40MHz
|
|
if crystal_freq_detect == 48 and crystal_freq_rom_expect == 40:
|
|
baud_rate = baud * 40 // 48
|
|
# If detect the XTAL is 40MHz, but the ROM code expects it to be 48MHz
|
|
elif crystal_freq_detect == 40 and crystal_freq_rom_expect == 48:
|
|
baud_rate = baud * 48 // 40
|
|
else:
|
|
ESPLoader.change_baud(self, baud_rate)
|
|
return
|
|
|
|
print(f"Changing baud rate to {baud_rate}")
|
|
self.command(self.ESP_CHANGE_BAUDRATE, struct.pack("<II", baud_rate, 0))
|
|
print("Changed.")
|
|
self._set_port_baudrate(baud)
|
|
time.sleep(0.05) # get rid of garbage sent during baud rate change
|
|
self.flush_input()
|
|
else:
|
|
ESPLoader.change_baud(self, baud)
|
|
|
|
def check_spi_connection(self, spi_connection):
|
|
if not set(spi_connection).issubset(set(range(0, 29))):
|
|
raise FatalError("SPI Pin numbers must be in the range 0-28.")
|
|
if any([v for v in spi_connection if v in [13, 14]]):
|
|
print(
|
|
"WARNING: GPIO pins 13 and 14 are used by USB-Serial/JTAG, "
|
|
"consider using other pins for SPI flash connection."
|
|
)
|
|
|
|
|
|
class ESP32C5StubLoader(ESP32C5ROM):
|
|
"""Access class for ESP32C5 stub loader, runs on top of ROM.
|
|
|
|
(Basically the same as ESP32StubLoader, but different base class.
|
|
Can possibly be made into a mixin.)
|
|
"""
|
|
|
|
FLASH_WRITE_SIZE = 0x4000 # matches MAX_WRITE_BLOCK in stub_loader.c
|
|
STATUS_BYTES_LENGTH = 2 # same as ESP8266, different to ESP32 ROM
|
|
IS_STUB = True
|
|
|
|
def __init__(self, rom_loader):
|
|
self.secure_download_mode = rom_loader.secure_download_mode
|
|
self._port = rom_loader._port
|
|
self._trace_enabled = rom_loader._trace_enabled
|
|
self.cache = rom_loader.cache
|
|
self.flush_input() # resets _slip_reader
|
|
|
|
|
|
ESP32C5ROM.STUB_CLASS = ESP32C5StubLoader
|