embassy-mcxa

Crates

git

Versions

mcx-a256

Flavors

Div4

Struct Div4 

Source
pub struct Div4(/* private fields */);
Expand description

This type represents a divider in the range 1..=16.

At a hardware level, this is an 8-bit register from 0..=15, which adds one.

While the clock domain seems to use 8-bit dividers, the peripheral domain seems to use 4 bit dividers!

Implementations§

Source§

impl Div4

Source

pub const fn no_div() -> Self

Divide by one, or no division

Source

pub const fn from_raw(n: u8) -> Option<Self>

Store a “raw” divisor value that will divide the source by (n + 1), e.g. Div4::from_raw(0) will divide the source by 1, and Div4::from_raw(15) will divide the source by 16.

Source

pub const fn from_divisor(n: u8) -> Option<Self>

Store a specific divisor value that will divide the source by n. e.g. Div4::from_divisor(1) will divide the source by 1, and Div4::from_divisor(16) will divide the source by 16.

Will return None if n is not in the range 1..=16. Consider Self::from_raw for an infallible version.

Source

pub const fn into_bits(self) -> u8

Convert into “raw” bits form

Source

pub const fn into_divisor(self) -> u32

Convert into “divisor” form, as a u32 for convenient frequency math

Trait Implementations§

Source§

impl Clone for Div4

Source§

fn clone(&self) -> Div4

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Div4

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Div4

Source§

fn eq(&self, other: &Div4) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Div4

Source§

impl Eq for Div4

Source§

impl StructuralPartialEq for Div4

Auto Trait Implementations§

§

impl Freeze for Div4

§

impl RefUnwindSafe for Div4

§

impl Send for Div4

§

impl Sync for Div4

§

impl Unpin for Div4

§

impl UnwindSafe for Div4

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.