#![allow(dead_code, reason = "Some of this is bound to be unused")]
#![allow(missing_docs, reason = "Experimental")]
use esp_rom_sys::rom::{ets_delay_us, ets_update_cpu_frequency_rom};
use crate::{
clock::Clocks,
peripherals::{I2C_ANA_MST, LPWR, SYSTEM, TIMG0, UART0, UART1},
rtc_cntl::Rtc,
soc::regi2c,
time::Rate,
};
define_clock_tree_types!();
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[allow(
clippy::enum_variant_names,
reason = "MHz suffix indicates physical unit."
)]
#[non_exhaustive]
pub enum CpuClock {
#[default]
_80MHz = 80,
_120MHz = 120,
}
impl CpuClock {
const PRESET_80: ClockConfig = ClockConfig {
xtal_clk: None,
system_pre_div: None,
cpu_pll_div: Some(CpuPllDivConfig::new(CpuPllDivDivisor::_6)),
cpu_clk: Some(CpuClkConfig::Pll),
rc_fast_clk_div_n: Some(RcFastClkDivNConfig::new(0)),
rtc_slow_clk: Some(RtcSlowClkConfig::RcSlow),
rtc_fast_clk: Some(RtcFastClkConfig::Rc),
low_power_clk: Some(LowPowerClkConfig::RtcSlow),
timg_calibration_clock: None,
};
const PRESET_120: ClockConfig = ClockConfig {
xtal_clk: None,
system_pre_div: None,
cpu_pll_div: Some(CpuPllDivConfig::new(CpuPllDivDivisor::_4)),
cpu_clk: Some(CpuClkConfig::Pll),
rc_fast_clk_div_n: Some(RcFastClkDivNConfig::new(0)),
rtc_slow_clk: Some(RtcSlowClkConfig::RcSlow),
rtc_fast_clk: Some(RtcFastClkConfig::Rc),
low_power_clk: Some(LowPowerClkConfig::RtcSlow),
timg_calibration_clock: None,
};
}
impl From<CpuClock> for ClockConfig {
fn from(value: CpuClock) -> ClockConfig {
match value {
CpuClock::_80MHz => CpuClock::PRESET_80,
CpuClock::_120MHz => CpuClock::PRESET_120,
}
}
}
impl Default for ClockConfig {
fn default() -> Self {
Self::from(CpuClock::default())
}
}
impl ClockConfig {
pub(crate) fn try_get_preset(self) -> Option<CpuClock> {
match self {
v if v == CpuClock::PRESET_80 => Some(CpuClock::_80MHz),
v if v == CpuClock::PRESET_120 => Some(CpuClock::_120MHz),
_ => None,
}
}
pub(crate) fn configure(mut self) {
ClockTree::with(|clocks| {
configure_xtal_clk(clocks, XtalClkConfig::_40);
configure_system_pre_div(clocks, SystemPreDivConfig::new(0));
configure_cpu_clk(clocks, CpuClkConfig::Xtal);
});
if self.xtal_clk.is_none() {
let xtal = ClockTree::with(detect_xtal_freq);
debug!("Auto-detected XTAL frequency: {}", xtal.value());
self.xtal_clk = Some(xtal);
}
self.apply();
}
}
fn detect_xtal_freq(clocks: &mut ClockTree) -> XtalClkConfig {
const CALIBRATION_CYCLES: u32 = 10;
LPWR::regs()
.clk_conf()
.modify(|_, w| w.dig_clk8m_d256_en().set_bit());
let (xtal_cycles, calibration_clock_frequency) = Clocks::measure_rtc_clock(
clocks,
TimgCalibrationClockConfig::RcFastDivClk,
TimgFunctionClockConfig::XtalClk,
CALIBRATION_CYCLES,
);
LPWR::regs()
.clk_conf()
.modify(|_, w| w.dig_clk8m_d256_en().clear_bit());
let mhz = (calibration_clock_frequency * xtal_cycles / CALIBRATION_CYCLES).as_mhz();
if mhz.abs_diff(40) < mhz.abs_diff(26) {
XtalClkConfig::_40
} else {
XtalClkConfig::_26
}
}
fn configure_xtal_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<XtalClkConfig>,
config: XtalClkConfig,
) {
let freq_mhz = config.value() / 1_000_000;
LPWR::regs().store4().modify(|r, w| unsafe {
let disable_rom_log_bit = r.bits() & Rtc::RTC_DISABLE_ROM_LOG;
let half = (freq_mhz & (0xFFFF & !Rtc::RTC_DISABLE_ROM_LOG)) | disable_rom_log_bit;
w.data().bits(half | (half << 16))
});
}
fn enable_pll_clk_impl(clocks: &mut ClockTree, en: bool) {
const I2C_BBPLL_OC_DCHGP_LSB: u32 = 4;
const I2C_BBPLL_OC_DHREF_SEL_LSB: u32 = 4;
const I2C_BBPLL_OC_DLREF_SEL_LSB: u32 = 6;
I2C_ANA_MST::regs()
.ana_config()
.modify(|_, w| w.bbpll_pd().bit(!en));
LPWR::regs().options0().modify(|_, w| {
let power_down = !en;
w.bb_i2c_force_pd().bit(power_down);
w.bbpll_force_pd().bit(power_down);
w.bbpll_i2c_force_pd().bit(power_down)
});
if !en {
return;
}
SYSTEM::regs()
.cpu_per_conf()
.modify(|_, w| w.pll_freq_sel().set_bit());
I2C_ANA_MST::regs().ana_conf0().modify(|_, w| {
w.bbpll_stop_force_high().clear_bit();
w.bbpll_stop_force_low().set_bit()
});
let div_ref: u8;
let div7_0: u8;
let dr1: u8;
let dr3: u8;
let dchgp: u8;
let dcur: u8;
let dbias: u8;
match unwrap!(clocks.xtal_clk) {
XtalClkConfig::_26 => {
div_ref = 12;
div7_0 = 236;
dr1 = 4;
dr3 = 4;
dchgp = 0;
dcur = 0;
dbias = 2;
}
XtalClkConfig::_40 => {
div_ref = 0;
div7_0 = 8;
dr1 = 0;
dr3 = 0;
dchgp = 5;
dcur = 3;
dbias = 2;
}
}
regi2c::I2C_BBPLL_REG4.write_reg(0x6b);
let i2c_bbpll_lref = (dchgp << I2C_BBPLL_OC_DCHGP_LSB) | div_ref;
let i2c_bbpll_dcur =
(1 << I2C_BBPLL_OC_DLREF_SEL_LSB) | (3 << I2C_BBPLL_OC_DHREF_SEL_LSB) | dcur;
regi2c::I2C_BBPLL_OC_REF.write_reg(i2c_bbpll_lref);
regi2c::I2C_BBPLL_OC_DIV_REG.write_reg(div7_0);
regi2c::I2C_BBPLL_OC_DR1.write_field(dr1);
regi2c::I2C_BBPLL_OC_DR3.write_field(dr3);
regi2c::I2C_BBPLL_REG6.write_reg(i2c_bbpll_dcur);
regi2c::I2C_BBPLL_OC_VCO_DBIAS.write_field(dbias);
while I2C_ANA_MST::regs()
.ana_conf0()
.read()
.bbpll_cal_done()
.bit_is_clear()
{}
ets_delay_us(10);
I2C_ANA_MST::regs().ana_conf0().modify(|_, w| {
w.bbpll_stop_force_high().set_bit();
w.bbpll_stop_force_low().clear_bit()
});
}
fn enable_rc_fast_clk_impl(_clocks: &mut ClockTree, en: bool) {
const RTC_CNTL_FOSC_DFREQ_DEFAULT: u8 = 172;
LPWR::regs().clk_conf().modify(|_, w| {
unsafe { w.ck8m_dfreq().bits(RTC_CNTL_FOSC_DFREQ_DEFAULT) };
w.enb_ck8m().bit(!en);
w.dig_clk8m_en().bit(en); w.ck8m_force_pd().clear_bit();
w.ck8m_force_pu().clear_bit()
});
LPWR::regs()
.timer1()
.modify(|_, w| unsafe { w.ck8m_wait().bits(if en { 5 } else { 20 }) });
}
fn enable_osc_slow_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_rc_slow_clk_impl(_clocks: &mut ClockTree, en: bool) {
if !en {
return;
}
const RTC_CNTL_SCK_DCAP_DEFAULT: u8 = 255;
LPWR::regs()
.rtc_cntl()
.modify(|_, w| unsafe { w.sck_dcap().bits(RTC_CNTL_SCK_DCAP_DEFAULT) });
let slow_clk_conf = LPWR::regs().slow_clk_conf();
let new_value = slow_clk_conf.modify(|_, w| w.ana_clk_div_vld().clear_bit());
let new_value = slow_clk_conf.write(|w| unsafe {
w.bits(new_value);
w.ana_clk_div().bits(0)
});
slow_clk_conf.write(|w| {
unsafe { w.bits(new_value) };
w.ana_clk_div_vld().set_bit()
});
}
fn enable_rc_fast_div_clk_impl(_clocks: &mut ClockTree, en: bool) {
LPWR::regs()
.clk_conf()
.modify(|_, w| w.enb_ck8m_div().bit(!en));
}
fn enable_system_pre_div_in_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_system_pre_div_in_impl(
_clocks: &mut ClockTree,
_old_config: Option<SystemPreDivInConfig>,
_new_config: SystemPreDivInConfig,
) {
}
fn enable_system_pre_div_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_system_pre_div_impl(
_clocks: &mut ClockTree,
_old_config: Option<SystemPreDivConfig>,
new_config: SystemPreDivConfig,
) {
SYSTEM::regs()
.sysclk_conf()
.modify(|_, w| unsafe { w.pre_div_cnt().bits(new_config.divisor() as u16 & 0x3FF) });
}
fn enable_cpu_pll_div_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_cpu_pll_div_impl(
_clocks: &mut ClockTree,
_old_config: Option<CpuPllDivConfig>,
_new_config: CpuPllDivConfig,
) {
}
fn enable_apb_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_apb_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<ApbClkConfig>,
_new_config: ApbClkConfig,
) {
}
fn enable_crypto_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_crypto_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<CryptoClkConfig>,
_new_config: CryptoClkConfig,
) {
}
fn enable_mspi_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_mspi_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<MspiClkConfig>,
_new_config: MspiClkConfig,
) {
}
fn configure_cpu_clk_impl(
clocks: &mut ClockTree,
_old_config: Option<CpuClkConfig>,
new_config: CpuClkConfig,
) {
if new_config == CpuClkConfig::Pll {
SYSTEM::regs().cpu_per_conf().modify(|_, w| unsafe {
w.cpuperiod_sel()
.bits(match unwrap!(clocks.cpu_pll_div).divisor {
CpuPllDivDivisor::_4 => 1,
CpuPllDivDivisor::_6 => 0,
})
});
}
SYSTEM::regs().sysclk_conf().modify(|_, w| unsafe {
w.soc_clk_sel().bits(match new_config {
CpuClkConfig::Xtal => 0,
CpuClkConfig::RcFast => 2,
CpuClkConfig::Pll => 1,
})
});
let apb_freq = Rate::from_hz(apb_clk_frequency(clocks));
update_apb_frequency(apb_freq);
let cpu_freq = Rate::from_hz(cpu_clk_frequency(clocks));
ets_update_cpu_frequency_rom(cpu_freq.as_mhz());
}
fn update_apb_frequency(freq: Rate) {
let freq_shifted = (freq.as_hz() >> 12) & 0xFFFF;
let value = freq_shifted | (freq_shifted << 16);
LPWR::regs()
.store5()
.modify(|_, w| unsafe { w.data().bits(value) });
}
fn enable_pll_40m_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_pll_60m_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_pll_80m_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_cpu_div2_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_rc_fast_clk_div_n_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_rc_fast_clk_div_n_impl(
_clocks: &mut ClockTree,
_old_config: Option<RcFastClkDivNConfig>,
new_config: RcFastClkDivNConfig,
) {
let clk_conf = LPWR::regs().clk_conf();
let new_value = clk_conf.modify(|_, w| w.ck8m_div_sel_vld().clear_bit());
let new_value = clk_conf.write(|w| unsafe {
w.bits(new_value);
w.ck8m_div_sel().bits(new_config.divisor() as u8)
});
clk_conf.write(|w| {
unsafe { w.bits(new_value) };
w.ck8m_div_sel_vld().set_bit()
});
}
fn enable_xtal_div_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_rtc_slow_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_rtc_slow_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<RtcSlowClkConfig>,
new_config: RtcSlowClkConfig,
) {
LPWR::regs().clk_conf().modify(|_, w| unsafe {
w.ana_clk_rtc_sel().bits(match new_config {
RtcSlowClkConfig::OscSlow => 1,
RtcSlowClkConfig::RcSlow => 0,
RtcSlowClkConfig::RcFast => 2,
})
});
ets_delay_us(300);
}
fn enable_rtc_fast_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_rtc_fast_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<RtcFastClkConfig>,
new_config: RtcFastClkConfig,
) {
LPWR::regs().clk_conf().modify(|_, w| match new_config {
RtcFastClkConfig::Xtal => w.fast_clk_rtc_sel().clear_bit(),
RtcFastClkConfig::Rc => w.fast_clk_rtc_sel().set_bit(),
});
ets_delay_us(3);
}
fn enable_low_power_clk_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_low_power_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<LowPowerClkConfig>,
new_config: LowPowerClkConfig,
) {
SYSTEM::regs().bt_lpck_div_frac().modify(|_, w| {
w.lpclk_sel_8m()
.bit(new_config == LowPowerClkConfig::RcFast);
w.lpclk_sel_rtc_slow()
.bit(new_config == LowPowerClkConfig::RtcSlow);
w.lpclk_sel_xtal()
.bit(new_config == LowPowerClkConfig::Xtal);
w.lpclk_sel_xtal32k()
.bit(new_config == LowPowerClkConfig::OscSlow)
});
}
fn enable_uart_mem_clk_impl(_clocks: &mut ClockTree, en: bool) {
let regs = SYSTEM::regs();
if en {
regs.perip_rst_en0()
.modify(|_, w| w.uart_mem_rst().bit(true));
regs.perip_rst_en0()
.modify(|_, w| w.uart_mem_rst().bit(false));
}
regs.perip_clk_en0()
.modify(|_, w| w.uart_mem_clk_en().bit(en));
}
fn enable_timg_calibration_clock_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_timg_calibration_clock_impl(
_clocks: &mut ClockTree,
_old_config: Option<TimgCalibrationClockConfig>,
new_config: TimgCalibrationClockConfig,
) {
TIMG0::regs().rtccalicfg().modify(|_, w| unsafe {
w.rtc_cali_clk_sel().bits(match new_config {
TimgCalibrationClockConfig::RcSlowClk => 0,
TimgCalibrationClockConfig::RcFastDivClk => 1,
TimgCalibrationClockConfig::Osc32kClk => 2,
})
});
}
impl TimgInstance {
fn enable_function_clock_impl(self, _clocks: &mut ClockTree, en: bool) {
TIMG0::regs()
.regclk()
.modify(|_, w| w.timer_clk_is_active().bit(en));
}
fn configure_function_clock_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<TimgFunctionClockConfig>,
new_config: TimgFunctionClockConfig,
) {
TIMG0::regs().t(0).config().modify(|_, w| {
w.use_xtal()
.bit(new_config == TimgFunctionClockConfig::XtalClk)
});
}
fn enable_wdt_clock_impl(self, _clocks: &mut ClockTree, _en: bool) {
}
fn configure_wdt_clock_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<TimgWdtClockConfig>,
new_config: TimgWdtClockConfig,
) {
TIMG0::regs().wdtconfig0().modify(|_, w| {
w.wdt_use_xtal()
.bit(new_config == TimgWdtClockConfig::XtalClk)
});
}
}
impl UartInstance {
fn enable_function_clock_impl(self, _clocks: &mut ClockTree, en: bool) {
let regs = match self {
UartInstance::Uart0 => UART0::regs(),
UartInstance::Uart1 => UART1::regs(),
};
regs.clk_conf().modify(|_, w| w.sclk_en().bit(en));
}
fn configure_function_clock_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<UartFunctionClockConfig>,
new_config: UartFunctionClockConfig,
) {
let regs = match self {
UartInstance::Uart0 => UART0::regs(),
UartInstance::Uart1 => UART1::regs(),
};
regs.clk_conf().modify(|_, w| unsafe {
w.sclk_sel().bits(match new_config.sclk {
UartFunctionClockSclk::PllF40m => 1,
UartFunctionClockSclk::RcFast => 2,
UartFunctionClockSclk::Xtal => 3,
});
w.sclk_div_num().bits(new_config.div_num as _)
});
}
fn enable_mem_clock_impl(self, _clocks: &mut ClockTree, _en: bool) {
}
fn configure_mem_clock_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<UartMemClockConfig>,
_new_config: UartMemClockConfig,
) {
}
fn enable_baud_rate_generator_impl(self, _clocks: &mut ClockTree, _en: bool) {
}
fn configure_baud_rate_generator_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<UartBaudRateGeneratorConfig>,
new_config: UartBaudRateGeneratorConfig,
) {
let regs = match self {
UartInstance::Uart0 => UART0::regs(),
UartInstance::Uart1 => UART1::regs(),
};
regs.clkdiv().write(|w| unsafe {
w.clkdiv().bits(new_config.integral as _);
w.frag().bits(new_config.fractional as _)
});
}
}