Struct kea_hal::clocks::osc::Osc

pub struct Osc<Status, OscType, Range, Gain, ExtalPinState, XtalPinState> { /* fields omitted */ }

External Oscillator Peripheral

Oscillator is Stopped (Disabled) by default.

Implementations

impl<OscType, Range, Gain, ExtalPinState, XtalPinState> Osc<Stopped, OscType, Range, Gain, ExtalPinState, XtalPinState>

pub fn into_running(
    self,
    extal_pin: PTB7<ExtalPinState>
) -> Osc<Running, OscType, Range, Gain, ExtalPinState, XtalPinState>

Start-up the oscillator. Blocks until the oscillator is running.

pub fn release_extal_pin(
    self
) -> (Result<PTB7<ExtalPinState>, Error>, Osc<Stopped, OscType, Range, Gain, DontCare, XtalPinState>)

Returns the pin used for the EXTAL input

@TODO what is the state of the pin after decoupling from OSC peripheral?

impl<OscType, Range, Gain, ExtalPinState, XtalPinState> Osc<Running, OscType, Range, Gain, ExtalPinState, XtalPinState>

pub fn into_unstoppable(
    self
) -> Osc<Unstoppable, OscType, Range, Gain, ExtalPinState, XtalPinState>

Allow the OSC peripheral to continue running when the system goes into STOP mode.

pub fn into_stopped(
    self
) -> Osc<Stopped, OscType, Range, Gain, ExtalPinState, XtalPinState>

Stop (disable) the OSC peripheral

@TODO think of ways to not ruin someones day if they are using OSC_OUT as a reference clock.

impl<OscType, Range, Gain, ExtalPinState, XtalPinState> Osc<Unstoppable, OscType, Range, Gain, ExtalPinState, XtalPinState>

pub fn into_running(
    self
) -> Osc<Running, OscType, Range, Gain, ExtalPinState, XtalPinState>

Allow the OSC peripheral to be stopped when the system goes into STOP mode.

pub fn into_stopped(
    self
) -> Osc<Stopped, OscType, Range, Gain, ExtalPinState, XtalPinState>

Stop (disable) the OSC peripheral

@TODO think of ways to not ruin someones day if they are using OSC_OUT as a reference clock.

impl<Status, Range, Gain, ExtalPinState, XtalPinState> Osc<Status, ExtOsc, Range, Gain, ExtalPinState, XtalPinState>

pub fn into_ext_clock(
    self
) -> Osc<Status, ExtClock, Range, Gain, ExtalPinState, XtalPinState>

Change to External Clock mode (not resonator or crystal)

Consumes Pin PTB

impl<Status, Range, Gain, ExtalPinState, XtalPinState> Osc<Status, ExtClock, Range, Gain, ExtalPinState, XtalPinState>

pub fn into_ext_osc(
    self
) -> Osc<Status, ExtOsc, Range, Gain, ExtalPinState, XtalPinState>

Change to External oscillator / resonator mode

Consumes Pins PTB6:PTB7

pub fn release_xtal_pin(
    self
) -> (Result<PTB6<XtalPinState>, Error>, Osc<Status, ExtClock, Range, Gain, ExtalPinState, DontCare>)

Returns the pin used for the XTAL input.

This pin is only needed for the external oscillator / resonator mode.

@TODO what is the state of the pin after decoupling from OSC peripheral?

impl<OscType, Gain, ExtalPinState, XtalPinState> Osc<Stopped, OscType, LowRange, Gain, ExtalPinState, XtalPinState>

pub fn into_high_range(
    self
) -> Osc<Stopped, OscType, HighRange, Gain, ExtalPinState, XtalPinState>

Set to high range.

4-20MHz input. Range must be set while the Osc module is disabled.

impl<OscType, Gain, ExtalPinState, XtalPinState> Osc<Stopped, OscType, HighRange, Gain, ExtalPinState, XtalPinState>

pub fn into_low_range(
    self
) -> Osc<Stopped, OscType, HighRange, Gain, ExtalPinState, XtalPinState>

Set to low range.

Roughly 32kHZ. Range must be set while the Osc module is disabled.

impl<Status, OscType, Range, ExtalPinState, XtalPinState> Osc<Status, OscType, Range, HighGain, ExtalPinState, XtalPinState>

pub fn into_variable_gain(
    self
) -> Osc<Status, OscType, Range, VariableGain, ExtalPinState, XtalPinState>

Set the Oscillator to use Variable Gain.

This mode adjusts the oscillator gain to get an acceptable amplitude, minimizing power used.

impl<Status, OscType, Range, ExtalPinState, XtalPinState> Osc<Status, OscType, Range, HighGain, ExtalPinState, XtalPinState>

pub fn into_high_gain(
    self
) -> Osc<Status, OscType, Range, HighGain, ExtalPinState, XtalPinState>

Set the Oscillator to use High Gain

This mode attempts to get rail-to-rail output from the oscillator or resonator.