Struct rp2040_hal::xosc::CrystalOscillator

pub struct CrystalOscillator<S: State> { /* private fields */ }

A Crystal Oscillator.

Implementations

impl<S: State> CrystalOscillator<S>

pub fn free(self) -> XOSC

Releases the underlying device.

impl CrystalOscillator<Disabled>

pub fn new(dev: XOSC) -> Self

Creates a new CrystalOscillator from the underlying device.

pub fn initialize( self, frequency: HertzU32, startup_delay_multiplier: u32 ) -> Result<CrystalOscillator<Unstable>, Error>

Initializes the XOSC : frequency range is set, startup delay is calculated and set. Set startup_delay_multiplier to a value > 1 when using a slow-starting oscillator.

impl CrystalOscillator<Unstable>

pub fn await_stabilization(&self) -> Result<StableOscillatorToken, Infallible>

One has to wait for the startup delay before using the oscillator, ie awaiting stabilization of the XOSC

pub fn get_stable( self, _token: StableOscillatorToken ) -> CrystalOscillator<Stable>

Returns the stabilized oscillator

impl CrystalOscillator<Stable>

pub fn operating_frequency(&self) -> HertzU32

Operating frequency of the XOSC in hertz

pub fn disable(self) -> CrystalOscillator<Disabled>

Disables the XOSC

pub unsafe fn dormant(self) -> CrystalOscillator<Unstable>

Put the XOSC in DORMANT state. The method returns after the processor awakens.

After waking up from the DORMANT state, XOSC needs to re-stabilise.

Safety

This method is marked unsafe because prior to switch the XOSC into DORMANT state, PLLs must be stopped and IRQs have to be properly configured. This method does not do any of that, it merely switches the XOSC to DORMANT state. It should only be called if this oscillator is the clock source for the system clock. See Chapter 2, Section 16, §5) for details.

Trait Implementations

impl ClockSource for CrystalOscillator<Stable>

fn get_freq(&self) -> HertzU32

Get the operating frequency for this source

impl ValidSrc<AdcClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkAdcSrcType

Get register value for this ClockSource

impl ValidSrc<GpioOutput0Clock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkGpout0SrcType

Get register value for this ClockSource

impl ValidSrc<GpioOutput1Clock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkGpout1SrcType

Get register value for this ClockSource

impl ValidSrc<GpioOutput2Clock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkGpout2SrcType

Get register value for this ClockSource

impl ValidSrc<GpioOutput3Clock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkGpout3SrcType

Get register value for this ClockSource

impl ValidSrc<PeripheralClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkPeriSrcType

Get register value for this ClockSource

impl ValidSrc<ReferenceClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkRefSrcType

Get register value for this ClockSource

impl ValidSrc<RtcClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkRtcSrcType

Get register value for this ClockSource

impl ValidSrc<SystemClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkSysSrcType

Get register value for this ClockSource

impl ValidSrc<UsbClock> for CrystalOscillator<Stable>

fn is_aux(&self) -> bool

Is this a ClockSource for src or aux?

fn variant(&self) -> ClkUsbSrcType

Get register value for this ClockSource