Enum tmc2209::reg::State

pub enum State {
    GCONF(GCONF),
    GSTAT(GSTAT),
    IFCNT(IFCNT),
    SLAVECONF(SLAVECONF),
    OTP_PROG(OTP_PROG),
    OTP_READ(OTP_READ),
    IOIN(IOIN),
    FACTORY_CONF(FACTORY_CONF),
    IHOLD_IRUN(IHOLD_IRUN),
    TPOWERDOWN(TPOWERDOWN),
    TSTEP(TSTEP),
    TPWMTHRS(TPWMTHRS),
    VACTUAL(VACTUAL),
    TCOOLTHRS(TCOOLTHRS),
    SGTHRS(SGTHRS),
    SG_RESULT(SG_RESULT),
    COOLCONF(COOLCONF),
    MSCNT(MSCNT),
    MSCURACT(MSCURACT),
    CHOPCONF(CHOPCONF),
    DRV_STATUS(DRV_STATUS),
    PWMCONF(PWMCONF),
    PWM_SCALE(PWM_SCALE),
    PWM_AUTO(PWM_AUTO),
}

A dynamic representation of a register’s 32-bit state.

Variants

GCONF(GCONF)

GSTAT(GSTAT)

IFCNT(IFCNT)

SLAVECONF(SLAVECONF)

OTP_PROG(OTP_PROG)

OTP_READ(OTP_READ)

IOIN(IOIN)

FACTORY_CONF(FACTORY_CONF)

IHOLD_IRUN(IHOLD_IRUN)

TPOWERDOWN(TPOWERDOWN)

TSTEP(TSTEP)

TPWMTHRS(TPWMTHRS)

VACTUAL(VACTUAL)

TCOOLTHRS(TCOOLTHRS)

SGTHRS(SGTHRS)

SG_RESULT(SG_RESULT)

COOLCONF(COOLCONF)

MSCNT(MSCNT)

MSCURACT(MSCURACT)

CHOPCONF(CHOPCONF)

DRV_STATUS(DRV_STATUS)

PWMCONF(PWMCONF)

PWM_SCALE(PWM_SCALE)

PWM_AUTO(PWM_AUTO)

Implementations

impl State

pub fn from_addr_and_data(addr: Address, data: u32) -> Self

Construct a register state from its address and data represented as a u32.

pub fn from_addr_default(addr: Address) -> Self

Construct the default register state associated with the given address.

pub fn addr(&self) -> Address

The address of the register with which this state is associated.

pub fn reg<R>(&self) -> Result<&R, UnexpectedAddress> where
    R: 'static + Register, 

Attempt to retrieve a reference to a register of type R from the dynamic register State representation.

Returns an Err if the register type does not match.

pub fn reg_mut<R>(&mut self) -> Result<&mut R, UnexpectedAddress> where
    R: 'static + Register, 

Attempt to retrieve a mutable reference to a register of type R from the dynamic register State representation.

Returns an Err if the register type does not match.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<CHOPCONF> for State

fn from(r: CHOPCONF) -> Self

Performs the conversion.

impl From<COOLCONF> for State

fn from(r: COOLCONF) -> Self

Performs the conversion.

impl From<DRV_STATUS> for State

fn from(r: DRV_STATUS) -> Self

Performs the conversion.

impl From<FACTORY_CONF> for State

fn from(r: FACTORY_CONF) -> Self

Performs the conversion.

impl From<GCONF> for State

fn from(r: GCONF) -> Self

Performs the conversion.

impl From<GSTAT> for State

fn from(r: GSTAT) -> Self

Performs the conversion.

impl From<IFCNT> for State

fn from(r: IFCNT) -> Self

Performs the conversion.

impl From<IHOLD_IRUN> for State

fn from(r: IHOLD_IRUN) -> Self

Performs the conversion.

impl From<IOIN> for State

fn from(r: IOIN) -> Self

Performs the conversion.

impl From<MSCNT> for State

fn from(r: MSCNT) -> Self

Performs the conversion.

impl From<MSCURACT> for State

fn from(r: MSCURACT) -> Self

Performs the conversion.

impl From<OTP_PROG> for State

fn from(r: OTP_PROG) -> Self

Performs the conversion.

impl From<OTP_READ> for State

fn from(r: OTP_READ) -> Self

Performs the conversion.

impl From<PWMCONF> for State

fn from(r: PWMCONF) -> Self

Performs the conversion.

impl From<PWM_AUTO> for State

fn from(r: PWM_AUTO) -> Self

Performs the conversion.

impl From<PWM_SCALE> for State

fn from(r: PWM_SCALE) -> Self

Performs the conversion.

impl From<SGTHRS> for State

fn from(r: SGTHRS) -> Self

Performs the conversion.

impl From<SG_RESULT> for State

fn from(r: SG_RESULT) -> Self

Performs the conversion.

impl From<SLAVECONF> for State

fn from(r: SLAVECONF) -> Self

Performs the conversion.

impl From<TCOOLTHRS> for State

fn from(r: TCOOLTHRS) -> Self

Performs the conversion.

impl From<TPOWERDOWN> for State

fn from(r: TPOWERDOWN) -> Self

Performs the conversion.

impl From<TPWMTHRS> for State

fn from(r: TPWMTHRS) -> Self

Performs the conversion.

impl From<TSTEP> for State

fn from(r: TSTEP) -> Self

Performs the conversion.

impl From<VACTUAL> for State

fn from(r: VACTUAL) -> Self

Performs the conversion.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Hash for State

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Into<u32> for State

fn into(self) -> u32

Performs the conversion.

impl PartialEq<State> for State

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for State

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<State> for GCONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for GSTAT

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for TSTEP

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for TPWMTHRS

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for VACTUAL

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for TCOOLTHRS

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for SGTHRS

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for SG_RESULT

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for COOLCONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for MSCNT

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for MSCURACT

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for CHOPCONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for IFCNT

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for DRV_STATUS

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for PWMCONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for PWM_SCALE

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for PWM_AUTO

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for SLAVECONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for OTP_PROG

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for OTP_READ

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for IOIN

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for FACTORY_CONF

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for IHOLD_IRUN

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<State> for TPOWERDOWN

type Error = UnexpectedAddress

The type returned in the event of a conversion error.

fn try_from(state: State) -> Result<Self, Self::Error>

Performs the conversion.

impl uDebug for State

fn fmt<W: ?Sized>(&self, f: &mut Formatter<'_, W>) -> Result<(), W::Error> where
    W: uWrite, 

Formats the value using the given formatter

impl Copy for State

impl Eq for State

impl StructuralEq for State

impl StructuralPartialEq for State