Struct stm32f412g::clocks::pll::Pll

pub struct Pll<'a, PllConstants> { /* private fields */ }

Main PLL clock structure.

Implementations

impl<'a, PllConstants> Pll<'a, PllConstants>

where PllConstants: PllConstants,

pub fn enable(&self) -> Result<(), ErrorCode>

Start the PLL clock.

Errors

• Err(ErrorCode::BUSY): if enabling the PLL clock took too long. Recall this method to ensure the PLL clock is running.

pub fn disable(&self) -> Result<(), ErrorCode>

Stop the PLL clock.

Errors

• Err(ErrorCode::FAIL): if the PLL clock is configured as the system clock.
• Err(ErrorCode::BUSY): disabling the PLL clock took to long. Retry to ensure it is not running.

pub fn is_enabled(&self) -> bool

Check whether the PLL clock is enabled or not.

Returns

• false: the PLL clock is not enabled
• true: the PLL clock is enabled

pub fn get_frequency_mhz(&self) -> Option<usize>

Get the frequency in MHz of the PLL clock.

Returns

• Some(frequency_mhz): if the PLL clock is enabled.
• None: if the PLL clock is disabled.

pub fn get_frequency_mhz_no_cache( &self, source_frequency: usize, ) -> Option<usize>

Get the frequency in MHz of the PLL clock from RCC registers instead of using the cached value.

Returns

• Some(frequency_mhz): if the PLL clock is enabled.
• None: if the PLL clock is disabled.

pub fn get_frequency_mhz_pll48(&self) -> Option<usize>

Get the frequency in MHz of the PLL48 clock.

NOTE: If the PLL clock was not configured with a frequency multiple of 48MHz, the returned value is inaccurate.

Returns

• Some(frequency_mhz): if the PLL clock is enabled.
• None: if the PLL clock is disabled.

pub fn is_pll48_calibrated(&self) -> bool

Check if the PLL48 clock is calibrated (its output is exactly 48MHz).

A frequency of 48MHz is required for USB OTG FS.

Returns

• true: the PLL48 clock frequency is exactly 48MHz.
• false: the PLL48 clock is not exactly 48MHz.