Struct atsamd_hal::clock::v2::pclk::Pclk

pub struct Pclk<P, I>where
    P: PclkId,
    I: PclkSourceId,{ /* private fields */ }

Peripheral channel clock for a given peripheral

Peripheral channel clocks connect generic clock generators (Gclks) to various peripherals. Pclks usually act as leaves in the clock tree, except when they feed the DFLL and DPLL peripherals.

The type parameter P is a PclkId that determines which of the 48 peripherals this Pclk feeds. The type parameter I represents the Id type for the EnabledGclk acting as the Pclk’s Source. It must be one of the valid PclkSourceIds, which is simply a trait alias for GclkId. See the clock module documentation for more detail on Id types.

Pclks cannot act as general purpose clock Sources; rather, they map 1:1 with corresponding peripherals. Thus, enabled Pclks do not need a compile-time counter of consumer clocks, so they are not wrapped with Enabled. Enabled Pclks are created directly from PclkTokens with Pclk::enable.

See the module-level documentation for an example.

Implementations

impl<P, I> Pclk<P, I>where
    P: PclkId,
    I: PclkSourceId,

pub fn enable<S>(token: PclkToken<P>, gclk: S) -> (Self, S::Inc)where
    S: Source<Id = I> + Increment,

Create and enable a Pclk

Creating a Pclk immediately enables the corresponding peripheral channel clock. It also Increments the Source’s Enabled counter.

Note that the Source will always be an EnabledGclk.

pub fn disable<S>(self, gclk: S) -> (PclkToken<P>, S::Dec)where
    S: Source<Id = I> + Decrement,

Disable and destroy a Pclk

Consume the Pclk, release the PclkToken, and Decrement the EnabledGclk’s counter

pub fn freq(&self) -> Hertz

Return the Pclk frequency

Trait Implementations

impl<I: PclkSourceId> From<Pclk<Ac, I>> for AcClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Ac, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Adc0, I>> for Adc0Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Adc0, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Adc1, I>> for Adc1Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Adc1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<CM4Trace, I>> for Cm4TraceClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<CM4Trace, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Ccl, I>> for CclClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Ccl, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Dac, I>> for DacClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Dac, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Eic, I>> for EicClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Eic, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys0, I>> for Evsys0Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys0, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys1, I>> for Evsys1Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys10, I>> for Evsys10Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys10, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys11, I>> for Evsys11Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys11, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys2, I>> for Evsys2Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys2, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys3, I>> for Evsys3Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys3, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys4, I>> for Evsys4Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys4, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys5, I>> for Evsys5Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys5, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys6, I>> for Evsys6Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys6, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys7, I>> for Evsys7Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys7, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys8, I>> for Evsys8Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys8, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<EvSys9, I>> for Evsys9Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<EvSys9, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<FreqMMeasure, I>> for FreqmMsrClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<FreqMMeasure, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<FreqMReference, I>> for FreqmRefClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<FreqMReference, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<I2S0, I>> for I2S0Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<I2S0, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<I2S1, I>> for I2S1Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<I2S1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<PDec, I>> for PdecClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<PDec, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM0, I>> for Sercom0CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom0, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM1, I>> for Sercom1CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM2, I>> for Sercom2CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom2, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM3, I>> for Sercom3CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom3, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM4, I>> for Sercom4CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom4, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<SERCOM5, I>> for Sercom5CoreClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sercom5, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Sdhc0, I>> for Sdhc0Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Sdhc0, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tc0Tc1, I>> for Tc0Tc1Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tc0Tc1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tc2Tc3, I>> for Tc2Tc3Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tc2Tc3, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tc4Tc5, I>> for Tc4Tc5Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tc4Tc5, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tcc0Tcc1, I>> for Tcc0Tcc1Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tcc0Tcc1, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tcc2Tcc3, I>> for Tcc2Tcc3Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tcc2Tcc3, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Tcc4, I>> for Tcc4Clock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Tcc4, I>) -> Self

Converts to this type from the input type.

impl<I: PclkSourceId> From<Pclk<Usb, I>> for UsbClock

V2 to V1 compatibility layer that allows to convert V2 Pclk constructs into corresponding V1 *Clock types. Thus, user can manage V1 clocking compatible peripherals while using V2 clocking API

fn from(pclk: Pclk<Usb, I>) -> Self

Converts to this type from the input type.