Struct esp32_hal::clock_control::ClockControlConfig

pub struct ClockControlConfig {}

Clock configuration & locking for Dynamic Frequency Switching. It allows thread and interrupt safe way to switch between default, high CPU and APB frequency configuration.

Implementations

impl<'a> ClockControlConfig

pub fn cpu_frequency(&self) -> Hertz

The current CPU frequency

pub fn apb_frequency(&self) -> Hertz

The current APB frequency

pub fn cpu_frequency_default(&self) -> Hertz

The CPU frequency in the default state

pub fn cpu_frequency_locked(&self) -> Hertz

The CPU frequency in the CPU lock state

pub fn cpu_frequency_apb_locked(&self) -> Hertz

The CPU frequency in the APB lock state

pub fn apb_frequency_apb_locked(&self) -> Hertz

The APB frequency in the APB lock state

pub fn is_ref_clock_stable(&self) -> bool

Is the reference clock 1MHz under all clock conditions

pub fn ref_frequency(&self) -> Hertz

The current reference frequency

pub fn slow_rtc_frequency(&self) -> Hertz

The current slow RTC frequency

pub fn fast_rtc_frequency(&self) -> Hertz

The current fast RTC frequency

pub fn apll_frequency(&self) -> Hertz

The current APLL frequency

pub fn pll_d2_frequency(&self) -> Hertz

The current PLL/2 frequency

pub fn xtal_frequency(&self) -> Hertz

The Xtal frequency

pub fn xtal32k_frequency(&self) -> Hertz

The 32kHz Xtal frequency

pub fn pll_frequency(&self) -> Hertz

The current PLL frequency

pub fn rtc8m_frequency(&self) -> Hertz

The current 8MHz oscillator frequency

pub fn rtc8md256_frequency(&self) -> Hertz

The current 8MHz oscillator frequency / 256

pub fn rtc_frequency(&self) -> Hertz

The current 150kHz oscillator frequency

pub fn cpu_source(&self) -> CPUSource

The current source for the CPU and APB frequencies

pub fn slow_rtc_source(&self) -> SlowRTCSource

The current source for the slow RTC frequency

pub fn fast_rtc_source(&self) -> FastRTCSource

The current source for the fast RTC frequency

pub fn lock_cpu_frequency(&self) -> LockCPU

Obtain a RAII lock to use the high CPU frequency

pub fn lock_apb_frequency(&self) -> LockAPB

Obtain a RAII lock to use the APB CPU frequency

pub fn lock_awake(&self) -> LockAwake

Obtain a RAII lock to keep the CPU from sleeping

pub fn lock_plld2(&self) -> LockPllD2

Obtain a RAII lock to keep the PLL/2 from being turned off

pub fn add_callback<F>(&self, f: &'static F) -> Result<(), Error> where
    F: Fn(CPUSource, Hertz, Hertz, CPUSource, Hertz, Hertz), 

Add callback which will be called when clock speeds are changed.

NOTE: these callbacks are called in an interrupt free environment, so should be as short as possible

pub fn get_lock_count(&self) -> Locks

Get the current count of the PCU, APB, Awake and PLL/2 locks

pub unsafe fn park_core(&mut self, core: Core)

Halt the designated core

pub fn unpark_core(&mut self, core: Core)

Start the APP (second) core

The second core will start running with the function entry.

pub fn start_app_core(&mut self, entry: fn() -> !) -> Result<(), Error>

Start the APP (second) core

The second core will start running with the function entry.

pub fn rtc_tick_count(&self) -> TicksU64

Get RTC tick count since boot

Note: this function takes up to one slow RTC clock cycle (can be up to 300us) and interrupts are blocked during this time.

pub fn rtc_nanoseconds(&self) -> NanoSecondsU64

Get nanoseconds since boot based on RTC tick count

Note: this function takes up to one slow RTC clock cycle (can be up to 300us) and interrupts are blocked during this time.

Trait Implementations

impl Clone for ClockControlConfig

fn clone(&self) -> ClockControlConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ClockControlConfig

impl Debug for ClockControlConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.