use stm32_metapac::flash::vals::Latency; use stm32_metapac::rcc::vals::{Adcsel, Sw}; use stm32_metapac::FLASH; pub use crate::pac::rcc::vals::{ Adcsel as AdcClockSource, Clk48sel as Clk48Src, Fdcansel as FdCanClockSource, Hpre as AHBPrescaler, Pllm as PllPreDiv, Plln as PllMul, Pllp as PllPDiv, Pllq as PllQDiv, Pllr as PllRDiv, Pllsrc, Ppre as APBPrescaler, Sw as Sysclk, }; use crate::pac::{PWR, RCC}; use crate::time::Hertz; /// HSI speed pub const HSI_FREQ: Hertz = Hertz(16_000_000); /// HSE Mode #[derive(Clone, Copy, Eq, PartialEq)] pub enum HseMode { /// crystal/ceramic oscillator (HSEBYP=0) Oscillator, /// external analog clock (low swing) (HSEBYP=1) Bypass, } /// HSE Configuration #[derive(Clone, Copy, Eq, PartialEq)] pub struct Hse { /// HSE frequency. pub freq: Hertz, /// HSE mode. pub mode: HseMode, } /// PLL Configuration /// /// Use this struct to configure the PLL source, input frequency, multiplication factor, and output /// dividers. Be sure to keep check the datasheet for your specific part for the appropriate /// frequency ranges for each of these settings. pub struct Pll { /// PLL Source clock selection. pub source: Pllsrc, /// PLL pre-divider pub prediv: PllPreDiv, /// PLL multiplication factor for VCO pub mul: PllMul, /// PLL division factor for P clock (ADC Clock) pub divp: Option, /// PLL division factor for Q clock (USB, I2S23, SAI1, FDCAN, QSPI) pub divq: Option, /// PLL division factor for R clock (SYSCLK) pub divr: Option, } /// Clocks configutation #[non_exhaustive] pub struct Config { /// HSI Enable pub hsi: bool, /// HSE Configuration pub hse: Option, /// System Clock Configuration pub sys: Sysclk, /// HSI48 Configuration pub hsi48: Option, /// PLL Configuration pub pll: Option, /// Iff PLL is requested as the main clock source in the `mux` field then the PLL configuration /// MUST turn on the PLLR output. pub ahb_pre: AHBPrescaler, pub apb1_pre: APBPrescaler, pub apb2_pre: APBPrescaler, pub low_power_run: bool, /// Sets the clock source for the 48MHz clock used by the USB and RNG peripherals. pub clk48_src: Clk48Src, /// Low-Speed Clock Configuration pub ls: super::LsConfig, /// Clock Source for ADCs 1 and 2 pub adc12_clock_source: AdcClockSource, /// Clock Source for ADCs 3, 4 and 5 pub adc345_clock_source: AdcClockSource, /// Clock Source for FDCAN pub fdcan_clock_source: FdCanClockSource, /// Enable range1 boost mode /// Recommended when the SYSCLK frequency is greater than 150MHz. pub boost: bool, } impl Default for Config { #[inline] fn default() -> Config { Config { hsi: true, hse: None, sys: Sysclk::HSI, hsi48: Some(Default::default()), pll: None, ahb_pre: AHBPrescaler::DIV1, apb1_pre: APBPrescaler::DIV1, apb2_pre: APBPrescaler::DIV1, low_power_run: false, clk48_src: Clk48Src::HSI48, ls: Default::default(), adc12_clock_source: Adcsel::DISABLE, adc345_clock_source: Adcsel::DISABLE, fdcan_clock_source: FdCanClockSource::PCLK1, boost: false, } } } pub struct PllFreq { pub pll_p: Option, pub pll_q: Option, pub pll_r: Option, } pub(crate) unsafe fn init(config: Config) { // Configure HSI let hsi = match config.hsi { false => { RCC.cr().modify(|w| w.set_hsion(false)); None } true => { RCC.cr().modify(|w| w.set_hsion(true)); while !RCC.cr().read().hsirdy() {} Some(HSI_FREQ) } }; // Configure HSE let hse = match config.hse { None => { RCC.cr().modify(|w| w.set_hseon(false)); None } Some(hse) => { match hse.mode { HseMode::Bypass => assert!(max::HSE_BYP.contains(&hse.freq)), HseMode::Oscillator => assert!(max::HSE_OSC.contains(&hse.freq)), } RCC.cr().modify(|w| w.set_hsebyp(hse.mode != HseMode::Oscillator)); RCC.cr().modify(|w| w.set_hseon(true)); while !RCC.cr().read().hserdy() {} Some(hse.freq) } }; // Configure HSI48 if required if let Some(hsi48_config) = config.hsi48 { super::init_hsi48(hsi48_config); } let pll_freq = config.pll.map(|pll_config| { let src_freq = match pll_config.source { Pllsrc::HSI => unwrap!(hsi), Pllsrc::HSE => unwrap!(hse), _ => unreachable!(), }; assert!(max::PLL_IN.contains(&src_freq)); // Disable PLL before configuration RCC.cr().modify(|w| w.set_pllon(false)); while RCC.cr().read().pllrdy() {} let internal_freq = src_freq / pll_config.prediv * pll_config.mul; assert!(max::PLL_VCO.contains(&internal_freq)); RCC.pllcfgr().write(|w| { w.set_plln(pll_config.mul); w.set_pllm(pll_config.prediv); w.set_pllsrc(pll_config.source.into()); }); let pll_p_freq = pll_config.divp.map(|div_p| { RCC.pllcfgr().modify(|w| { w.set_pllp(div_p); w.set_pllpen(true); }); let freq = internal_freq / div_p; assert!(max::PCLK.contains(&freq)); freq }); let pll_q_freq = pll_config.divq.map(|div_q| { RCC.pllcfgr().modify(|w| { w.set_pllq(div_q); w.set_pllqen(true); }); let freq = internal_freq / div_q; assert!(max::PCLK.contains(&freq)); freq }); let pll_r_freq = pll_config.divr.map(|div_r| { RCC.pllcfgr().modify(|w| { w.set_pllr(div_r); w.set_pllren(true); }); let freq = internal_freq / div_r; assert!(max::PCLK.contains(&freq)); freq }); // Enable the PLL RCC.cr().modify(|w| w.set_pllon(true)); while !RCC.cr().read().pllrdy() {} PllFreq { pll_p: pll_p_freq, pll_q: pll_q_freq, pll_r: pll_r_freq, } }); let (sys_clk, sw) = match config.sys { Sysclk::HSI => (HSI_FREQ, Sw::HSI), Sysclk::HSE => (unwrap!(hse), Sw::HSE), Sysclk::PLL1_R => { assert!(pll_freq.is_some()); assert!(pll_freq.as_ref().unwrap().pll_r.is_some()); let freq = pll_freq.as_ref().unwrap().pll_r.unwrap().0; assert!(max::SYSCLK.contains(&Hertz(freq))); (Hertz(freq), Sw::PLL1_R) } _ => unreachable!(), }; // Calculate the AHB frequency (HCLK), among other things so we can calculate the correct flash read latency. let hclk = sys_clk / config.ahb_pre; assert!(max::HCLK.contains(&hclk)); // Configure Core Boost mode ([RM0440] p234 – inverted because setting r1mode to 0 enables boost mode!) if config.boost { // RM0440 p235 // “The sequence to switch from Range1 normal mode to Range1 boost mode is: // 1. The system clock must be divided by 2 using the AHB prescaler before switching to a higher system frequency. RCC.cfgr().modify(|w| w.set_hpre(AHBPrescaler::DIV2)); // 2. Clear the R1MODE bit in the PWR_CR5 register. (enables boost mode) PWR.cr5().modify(|w| w.set_r1mode(false)); // Below: // 3. Adjust wait states according to new freq target // 4. Configure and switch to new frequency } // Configure flash read access latency based on boost mode and frequency (RM0440 p98) FLASH.acr().modify(|w| { w.set_latency(match (config.boost, hclk.0) { (true, ..=34_000_000) => Latency::WS0, (true, ..=68_000_000) => Latency::WS1, (true, ..=102_000_000) => Latency::WS2, (true, ..=136_000_000) => Latency::WS3, (true, _) => Latency::WS4, (false, ..=36_000_000) => Latency::WS0, (false, ..=60_000_000) => Latency::WS1, (false, ..=90_000_000) => Latency::WS2, (false, ..=120_000_000) => Latency::WS3, (false, _) => Latency::WS4, }) }); if config.boost { // 5. Wait for at least 1us and then reconfigure the AHB prescaler to get the needed HCLK clock frequency. cortex_m::asm::delay(16); } // Now that boost mode and flash read access latency are configured, set up SYSCLK RCC.cfgr().modify(|w| { w.set_sw(sw); w.set_hpre(config.ahb_pre); w.set_ppre1(config.apb1_pre); w.set_ppre2(config.apb2_pre); }); let (apb1_freq, apb1_tim_freq) = super::util::calc_pclk(hclk, config.apb1_pre); let (apb2_freq, apb2_tim_freq) = super::util::calc_pclk(hclk, config.apb2_pre); // Configure the 48MHz clock source for USB and RNG peripherals. RCC.ccipr().modify(|w| { w.set_clk48sel(match config.clk48_src { Clk48Src::PLL1_Q => { // Not checking that PLL1_Q is 48MHz here so as not to require the user to have a 48MHz clock. // Peripherals which require one (USB, RNG) should check that they‘re driven by a valid 48MHz // clock at init. crate::pac::rcc::vals::Clk48sel::PLL1_Q } Clk48Src::HSI48 => { // Make sure HSI48 is enabled assert!(config.hsi48.is_some()); crate::pac::rcc::vals::Clk48sel::HSI48 } _ => unreachable!(), }) }); RCC.ccipr().modify(|w| w.set_adc12sel(config.adc12_clock_source)); RCC.ccipr().modify(|w| w.set_adc345sel(config.adc345_clock_source)); RCC.ccipr().modify(|w| w.set_fdcansel(config.fdcan_clock_source)); let adc12_ck = match config.adc12_clock_source { AdcClockSource::DISABLE => None, AdcClockSource::PLL1_P => pll_freq.as_ref().unwrap().pll_p, AdcClockSource::SYS => Some(sys_clk), _ => unreachable!(), }; let adc345_ck = match config.adc345_clock_source { AdcClockSource::DISABLE => None, AdcClockSource::PLL1_P => pll_freq.as_ref().unwrap().pll_p, AdcClockSource::SYS => Some(sys_clk), _ => unreachable!(), }; if config.low_power_run { assert!(sys_clk <= Hertz(2_000_000)); PWR.cr1().modify(|w| w.set_lpr(true)); } let rtc = config.ls.init(); set_clocks!( sys: Some(sys_clk), hclk1: Some(hclk), hclk2: Some(hclk), hclk3: Some(hclk), pclk1: Some(apb1_freq), pclk1_tim: Some(apb1_tim_freq), pclk2: Some(apb2_freq), pclk2_tim: Some(apb2_tim_freq), adc: adc12_ck, adc34: adc345_ck, pll1_p: pll_freq.as_ref().and_then(|pll| pll.pll_p), pll1_q: pll_freq.as_ref().and_then(|pll| pll.pll_q), pll1_r: pll_freq.as_ref().and_then(|pll| pll.pll_r), hse: hse, rtc: rtc, ); } /// Acceptable Frequency Ranges /// Currently assuming voltage scaling range 1 boost mode. /// Where not specified in the generic G4 reference manual (RM0440), values taken from the STM32G474 datasheet. /// If acceptable ranges for other G4-family chips differ, make additional max modules gated behind cfg attrs. mod max { use core::ops::RangeInclusive; use crate::time::Hertz; /// HSE Frequency Range (RM0440 p280) pub(crate) const HSE_OSC: RangeInclusive = Hertz(4_000_000)..=Hertz(48_000_000); /// External Clock Frequency Range (RM0440 p280) pub(crate) const HSE_BYP: RangeInclusive = Hertz(0)..=Hertz(48_000_000); /// SYSCLK Frequency Range (RM0440 p282) pub(crate) const SYSCLK: RangeInclusive = Hertz(0)..=Hertz(170_000_000); /// PLL Output Frequency Range (RM0440 p281, STM32G474 Datasheet p123, Table 46) pub(crate) const PCLK: RangeInclusive = Hertz(8)..=Hertz(170_000_000); /// HCLK (AHB) Clock Frequency Range (STM32G474 Datasheet) pub(crate) const HCLK: RangeInclusive = Hertz(0)..=Hertz(170_000_000); /// PLL Source Frequency Range (STM32G474 Datasheet p123, Table 46) pub(crate) const PLL_IN: RangeInclusive = Hertz(2_660_000)..=Hertz(16_000_000); /// PLL VCO (internal) Frequency Range (STM32G474 Datasheet p123, Table 46) pub(crate) const PLL_VCO: RangeInclusive = Hertz(96_000_000)..=Hertz(344_000_000); }