#![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::{
peripherals::{I2C_ANA_MST, LPWR, SYSCON, SYSTEM, TIMG0, TIMG1, UART0, UART1},
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,
_160MHz = 160,
_240MHz = 240,
}
impl CpuClock {
const PRESET_80: ClockConfig = ClockConfig {
xtal_clk: None,
pll_clk: Some(PllClkConfig::_480),
apll_clk: None,
cpu_pll_div: Some(CpuPllDivConfig::new(CpuPllDivDivisor::_6)),
system_pre_div: None,
cpu_clk: Some(CpuClkConfig::Pll),
rtc_slow_clk: Some(RtcSlowClkConfig::RcSlow),
rtc_fast_clk: Some(RtcFastClkConfig::Rc),
timg_calibration_clock: None,
};
const PRESET_160: ClockConfig = ClockConfig {
xtal_clk: None,
pll_clk: Some(PllClkConfig::_480),
apll_clk: None,
cpu_pll_div: Some(CpuPllDivConfig::new(CpuPllDivDivisor::_3)),
system_pre_div: None,
cpu_clk: Some(CpuClkConfig::Pll),
rtc_slow_clk: Some(RtcSlowClkConfig::RcSlow),
rtc_fast_clk: Some(RtcFastClkConfig::Rc),
timg_calibration_clock: None,
};
const PRESET_240: ClockConfig = ClockConfig {
xtal_clk: None,
pll_clk: Some(PllClkConfig::_480),
apll_clk: None,
cpu_pll_div: Some(CpuPllDivConfig::new(CpuPllDivDivisor::_2)),
system_pre_div: None,
cpu_clk: Some(CpuClkConfig::Pll),
rtc_slow_clk: Some(RtcSlowClkConfig::RcSlow),
rtc_fast_clk: Some(RtcFastClkConfig::Rc),
timg_calibration_clock: None,
};
}
impl From<CpuClock> for ClockConfig {
fn from(value: CpuClock) -> ClockConfig {
match value {
CpuClock::_80MHz => CpuClock::PRESET_80,
CpuClock::_160MHz => CpuClock::PRESET_160,
CpuClock::_240MHz => CpuClock::PRESET_240,
}
}
}
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_160 => Some(CpuClock::_160MHz),
v if v == CpuClock::PRESET_240 => Some(CpuClock::_240MHz),
_ => None,
}
}
pub(crate) fn configure(mut self) {
if self.xtal_clk.is_none() {
self.xtal_clk = Some(XtalClkConfig::_40);
}
ClockTree::with(|clocks| {
configure_xtal_clk(clocks, XtalClkConfig::_40);
configure_system_pre_div(clocks, SystemPreDivConfig::new(0));
configure_cpu_clk(clocks, CpuClkConfig::Xtal);
});
self.apply();
}
}
fn configure_xtal_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<XtalClkConfig>,
_config: XtalClkConfig,
) {
}
fn enable_pll_clk_impl(clocks: &mut ClockTree, en: bool) {
let power_down = !en;
I2C_ANA_MST::regs().config1().modify(|_, w| {
w.bbpll().bit(power_down);
w.apll().bit(power_down)
});
LPWR::regs().options0().modify(|_, w| {
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;
}
ensure_voltage_raised(clocks);
let div_ref: u8;
let div7_0: u8;
let dr1: u8;
let dr3: u8;
let dchgp: u8;
let dcur: u8;
let mode_hf: u8;
match unwrap!(clocks.pll_clk) {
PllClkConfig::_480 => {
div_ref = 0;
div7_0 = 8;
dr1 = 0;
dr3 = 0;
dchgp = 5;
dcur = 4;
mode_hf = 0x6B;
}
PllClkConfig::_320 => {
div_ref = 0;
div7_0 = 4;
dr1 = 0;
dr3 = 0;
dchgp = 5;
dcur = 5;
mode_hf = 0x69;
}
}
const I2C_BBPLL_OC_DCHGP_LSB: u8 = 4;
const I2C_BBPLL_OC_DLREF_SEL_LSB: u8 = 6;
const I2C_BBPLL_OC_DHREF_SEL_LSB: u8 = 4;
regi2c::I2C_BBPLL_REG4.write_reg(mode_hf);
let i2c_bbpll_lref = (dchgp << I2C_BBPLL_OC_DCHGP_LSB) | (div_ref);
let i2c_bbpll_dcur =
(2 << I2C_BBPLL_OC_DLREF_SEL_LSB) | (1 << I2C_BBPLL_OC_DHREF_SEL_LSB) | dcur;
regi2c::I2C_BBPLL_REG2.write_reg(i2c_bbpll_lref);
regi2c::I2C_BBPLL_REG3.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_IR_CAL_ENX_CAP.write_field(1);
let mut success = false;
for ext_cap in 0..16 {
regi2c::I2C_BBPLL_IR_CAL_EXT_CAP.write_field(ext_cap);
if regi2c::I2C_BBPLL_OR_CAL_CAP.read() == 0 {
success |= true;
break;
}
}
assert!(success, "BBPLL calibration failed");
ensure_voltage_minimal(clocks);
}
fn configure_pll_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<PllClkConfig>,
_config: PllClkConfig,
) {
}
fn enable_apll_clk_impl(_clocks: &mut ClockTree, en: bool) {
LPWR::regs().ana_conf().modify(|_, w| {
w.plla_force_pd().bit(!en);
w.plla_force_pu().bit(en)
});
if en {
todo!(
"Implement APLL configuration and calibration here. See esp-idf `clk_ll_apll_set_config`"
);
}
}
fn configure_apll_clk_impl(
_clocks: &mut ClockTree,
_old_config: Option<ApllClkConfig>,
_config: ApllClkConfig,
) {
}
fn enable_rc_fast_clk_impl(_clocks: &mut ClockTree, en: bool) {
const CLK_LL_RC_FAST_ENABLE_WAIT_DEFAULT: u8 = 5;
const CLK_LL_RC_FAST_WAIT_DEFAULT: u8 = 20;
LPWR::regs().clk_conf().modify(|_, w| w.enb_ck8m().bit(!en));
LPWR::regs().timer1().modify(|_, w| unsafe {
w.ck8m_wait().bits(if en {
CLK_LL_RC_FAST_ENABLE_WAIT_DEFAULT
} else {
CLK_LL_RC_FAST_WAIT_DEFAULT
})
});
if en {
ets_delay_us(50);
}
}
fn enable_cpu_pll_div_in_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_cpu_pll_div_in_impl(
_clocks: &mut ClockTree,
_old_config: Option<CpuPllDivInConfig>,
_new_config: CpuPllDivInConfig,
) {
}
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_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_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_ref_tick_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_ref_tick_impl(
_clocks: &mut ClockTree,
_old_config: Option<RefTickConfig>,
_new_config: RefTickConfig,
) {
}
fn enable_ref_tick_xtal_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_ref_tick_xtal_impl(
_clocks: &mut ClockTree,
_old_config: Option<RefTickXtalConfig>,
new_config: RefTickXtalConfig,
) {
SYSCON::regs()
.tick_conf()
.modify(|_, w| unsafe { w.xtal_tick_num().bits(new_config.divisor() as u8) });
}
fn enable_ref_tick_ck8m_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn configure_ref_tick_ck8m_impl(
_clocks: &mut ClockTree,
_old_config: Option<RefTickCk8mConfig>,
new_config: RefTickCk8mConfig,
) {
SYSCON::regs()
.tick_conf()
.modify(|_, w| unsafe { w.ck8m_tick_num().bits(new_config.divisor() as u8) });
}
fn configure_cpu_clk_impl(
clocks: &mut ClockTree,
_old_config: Option<CpuClkConfig>,
new_config: CpuClkConfig,
) {
let clock_source_sel0_bit = match new_config {
CpuClkConfig::Xtal => 0,
CpuClkConfig::RcFast => 2,
CpuClkConfig::Apll => 3,
CpuClkConfig::Pll => 1,
};
let clock_source_sel1_bit = clocks.pll_clk == Some(PllClkConfig::_480);
let clock_source_sel2_bit = match (clocks.pll_clk, clocks.cpu_pll_div) {
(Some(PllClkConfig::_480), Some(div)) if div.divisor() == 6 => 0,
(Some(PllClkConfig::_480), Some(div)) if div.divisor() == 3 => 1,
(Some(PllClkConfig::_480), Some(div)) if div.divisor() == 2 => 2,
(_, Some(div)) if div.divisor() == 4 => 0,
(_, Some(div)) if div.divisor() == 2 => 1,
_ => 0,
};
ensure_voltage_raised(clocks);
if new_config == CpuClkConfig::Pll {
SYSTEM::regs().cpu_per_conf().modify(|_, w| {
unsafe { w.cpuperiod_sel().bits(clock_source_sel2_bit) };
w.pll_freq_sel().bit(clock_source_sel1_bit)
});
}
SYSTEM::regs()
.sysclk_conf()
.modify(|_, w| unsafe { w.soc_clk_sel().bits(clock_source_sel0_bit) });
let cpu_freq = Rate::from_hz(cpu_clk_frequency(clocks));
ets_update_cpu_frequency_rom(cpu_freq.as_mhz());
let apb_freq = Rate::from_hz(apb_clk_frequency(clocks));
update_apb_frequency(apb_freq);
ensure_voltage_minimal(clocks);
}
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 uses_80mhz_flash() -> bool {
unsafe {
crate::soc::pac::SPI0::steal()
.clock()
.read()
.clk_equ_sysclk()
.bit_is_set()
}
}
fn is_max_cpu_speed(clocks: &mut ClockTree) -> bool {
clocks.cpu_clk == Some(CpuClkConfig::Pll)
&& clocks.pll_clk == Some(PllClkConfig::_480)
&& matches!(clocks.cpu_pll_div, Some(div) if div.divisor() == 2)
}
const RTC_CNTL_DBIAS_1V10: u8 = 4;
const RTC_CNTL_DBIAS_1V25: u8 = 7;
fn ensure_voltage_raised(clocks: &mut ClockTree) {
if is_max_cpu_speed(clocks) || uses_80mhz_flash() {
LPWR::regs().reg().modify(|_, w| unsafe {
w.dig_reg_dbias_wak().bits(RTC_CNTL_DBIAS_1V25);
w.dbias_wak().bits(RTC_CNTL_DBIAS_1V25)
});
ets_delay_us(40);
}
}
fn ensure_voltage_minimal(clocks: &mut ClockTree) {
if !is_max_cpu_speed(clocks) {
LPWR::regs().reg().modify(|_, w| unsafe {
if uses_80mhz_flash() {
w.dig_reg_dbias_wak().bits(RTC_CNTL_DBIAS_1V25);
} else {
w.dig_reg_dbias_wak().bits(RTC_CNTL_DBIAS_1V10);
}
w.dbias_wak().bits(RTC_CNTL_DBIAS_1V10)
});
ets_delay_us(40);
}
}
fn enable_apb_clk_cpu_div2_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_apb_clk_80m_impl(_clocks: &mut ClockTree, _en: bool) {
}
fn enable_xtal32k_clk_impl(_clocks: &mut ClockTree, en: bool) {
LPWR::regs().ext_xtl_conf().modify(|_, w| unsafe {
w.dac_xtal_32k().bits(3);
w.dres_xtal_32k().bits(3);
w.dgm_xtal_32k().bits(3);
w.dbuf_xtal_32k().bit(true);
w.xpd_xtal_32k().bit(en);
w.xtal32k_xpd_force().bit(!en)
});
LPWR::regs()
.clk_conf()
.modify(|_, w| w.dig_xtal32k_en().bit(en));
}
fn enable_rc_slow_clk_impl(_clocks: &mut ClockTree, en: bool) {
if en {
const RTC_CNTL_SCK_DCAP_DEFAULT: u8 = 255;
LPWR::regs()
.reg()
.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);
unsafe { w.ck8m_div().bits(1) } });
}
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::RcSlow => 0,
RtcSlowClkConfig::Xtal32k => 1,
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| w.fast_clk_rtc_sel().bit(new_config == RtcFastClkConfig::Rc));
ets_delay_us(3);
}
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::RtcClk => 0,
TimgCalibrationClockConfig::RcFastDivClk => 1,
TimgCalibrationClockConfig::Xtal32kClk => 2,
})
});
}
impl TimgInstance {
fn enable_function_clock_impl(self, _clocks: &mut ClockTree, en: bool) {
let regs = match self {
TimgInstance::Timg0 => TIMG0::regs(),
TimgInstance::Timg1 => TIMG1::regs(),
};
regs.regclk().modify(|_, w| w.clk_en().bit(en));
}
fn configure_function_clock_impl(
self,
_clocks: &mut ClockTree,
_old_config: Option<TimgFunctionClockConfig>,
new_config: TimgFunctionClockConfig,
) {
let regs = match self {
TimgInstance::Timg0 => TIMG0::regs(),
TimgInstance::Timg1 => TIMG1::regs(),
};
regs.t(0).config().modify(|_, w| {
w.use_xtal()
.bit(new_config == TimgFunctionClockConfig::XtalClk)
});
regs.t(1).config().modify(|_, w| {
w.use_xtal()
.bit(new_config == TimgFunctionClockConfig::XtalClk)
});
}
}
impl UartInstance {
fn enable_function_clock_impl(self, _clocks: &mut ClockTree, _en: bool) {
}
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.conf0().modify(|_, w| {
w.tick_ref_always_on()
.bit(new_config.sclk == UartFunctionClockSclk::Apb)
});
}
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 _)
});
}
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,
) {
}
}