Struct gd32f1x0_hal::pwm::Pwm

source · [−]

pub struct Pwm<TIMER, PINS> { /* private fields */ }

Implementations

source

impl<TIMER: Deref<Target = RB>, RB: TimerIdleRegExt, PINS: Pins<TIMER>> Pwm<TIMER, PINS>

source

pub fn set_idle_state(&self, channel: Channel, idle_state: IdleState)

Configure the state which the output of the given channel should have when the channel is idle.

source

impl<TIMER: Deref<Target = RB>, RB: TimerIdleRegExt, PINS: Pins<TIMER> + ComplementaryPins> Pwm<TIMER, PINS>

source

pub fn set_complementary_idle_state(
    &self,
    channel: Channel,
    idle_state: IdleState
)

Configure the state which the complementary output of the given channel should have when the channel is idle.

source

impl<TIMER: Deref<Target = RB>, RB: TimerRegExt, PINS: Pins<TIMER>> Pwm<TIMER, PINS>

source

pub fn set_polarity(&self, channel: Channel, polarity: Polarity)

Configure the polarity of the output for the given channel.

source

impl<TIMER: Deref<Target = RB>, RB: TimerRegExt, PINS: Pins<TIMER> + ComplementaryPins> Pwm<TIMER, PINS>

source

pub fn set_complementary_polarity(&self, channel: Channel, polarity: Polarity)

Configure the polarity of the complementary output for the given channel.

source

impl<P0, P1, P2, P3> Pwm<TIMER0, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>, Option<PwmChannel<TIMER0, P3>>)

Split the timer into separate PWM channels.

source

impl<P0, P1, P2> Pwm<TIMER0, (Option<P0>, Option<P1>, Option<P2>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>)

Split the timer into separate PWM channels.

source

impl<PINS> Pwm<TIMER0, PINS> where
PINS: Pins<TIMER0>,

source

pub fn stop(self) -> (Timer<TIMER0>, PINS)

Stop the timer and release it and the pins to be used for something else.

source

pub fn set_alignment(&self, alignment: Alignment)

Configure the given alignment mode, to control how pulses on different channels of this PWM module are aligned with each other.

source

pub fn listen(&mut self, event: Event)

Starts listening for an event.

source

pub fn unlisten(&mut self, event: Event)

Stops listening for an event.

source

pub fn is_pending(&self, event: Event) -> bool

Returns true if the given event interrupt is pending.

source

pub fn clear_interrupt_flag(&mut self, event: Event)

Clears the given event interrupt flag.

source

pub fn output_disable(&mut self)

Disable PWM outputs, and prevent them from being automatically enabled.

source

pub fn automatic_output_enable(&mut self)

Automatically enable outputs at the next update event, if the break input is not active.

source

pub fn break_enable(&self, break_mode: BreakMode)

Configure the given break mode.

source

pub fn run_mode_off_state(&mut self, enabled: bool)

Configure the run mode off-state.

source

pub fn idle_mode_off_state(&mut self, enabled: bool)

Configure the idle mode off-state.

source

pub fn set_dead_time(&self, dead_time: u16)

Configure the dead time for complementary chanels.

source

impl<P0, P1, P2, P3> Pwm<TIMER1, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>, Option<PwmChannel<TIMER1, P3>>)

Split the timer into separate PWM channels.

source

impl<P0, P1, P2> Pwm<TIMER1, (Option<P0>, Option<P1>, Option<P2>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>)

Split the timer into separate PWM channels.

source

impl<PINS> Pwm<TIMER1, PINS> where
PINS: Pins<TIMER1>,

source

pub fn stop(self) -> (Timer<TIMER1>, PINS)

Stop the timer and release it and the pins to be used for something else.

source

pub fn set_alignment(&self, alignment: Alignment)

Configure the given alignment mode, to control how pulses on different channels of this PWM module are aligned with each other.

source

pub fn listen(&mut self, event: Event)

Starts listening for an event.

source

pub fn unlisten(&mut self, event: Event)

Stops listening for an event.

source

pub fn is_pending(&self, event: Event) -> bool

Returns true if the given event interrupt is pending.

source

pub fn clear_interrupt_flag(&mut self, event: Event)

Clears the given event interrupt flag.

source

impl<P0, P1, P2, P3> Pwm<TIMER2, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>, Option<PwmChannel<TIMER2, P3>>)

Split the timer into separate PWM channels.

source

impl<P0, P1, P2> Pwm<TIMER2, (Option<P0>, Option<P1>, Option<P2>)>

source

pub fn split(
self
) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>)

Split the timer into separate PWM channels.

source

impl<PINS> Pwm<TIMER2, PINS> where
PINS: Pins<TIMER2>,

source

pub fn stop(self) -> (Timer<TIMER2>, PINS)

Stop the timer and release it and the pins to be used for something else.

source

pub fn set_alignment(&self, alignment: Alignment)

Configure the given alignment mode, to control how pulses on different channels of this PWM module are aligned with each other.

source

pub fn listen(&mut self, event: Event)

Starts listening for an event.

source

pub fn unlisten(&mut self, event: Event)

Stops listening for an event.

source

pub fn is_pending(&self, event: Event) -> bool

Returns true if the given event interrupt is pending.

source

pub fn clear_interrupt_flag(&mut self, event: Event)

Clears the given event interrupt flag.

Trait Implementations

source

impl<PINS> Pwm for Pwm<TIMER0, PINS> where
PINS: Pins<TIMER0>,

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Duty = u16

Type for the duty methods Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

source

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

source

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

source

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

source

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

source

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

source

fn get_period(&self) -> Self::Time

Returns the current PWM period

source

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

Sets a new PWM period

source

impl<PINS> Pwm for Pwm<TIMER1, PINS> where
PINS: Pins<TIMER1>,

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Duty = u16

Type for the duty methods Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

source

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

source

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

source

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

source

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

source

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

source

fn get_period(&self) -> Self::Time

Returns the current PWM period

source

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

Sets a new PWM period

source

impl<PINS> Pwm for Pwm<TIMER2, PINS> where
PINS: Pins<TIMER2>,

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Duty = u16

Type for the duty methods Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

source

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

source

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

source

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

source

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

source

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

source

fn get_period(&self) -> Self::Time

Returns the current PWM period

source

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

Sets a new PWM period

Auto Trait Implementations

impl<TIMER, PINS> RefUnwindSafe for Pwm<TIMER, PINS> where
PINS: RefUnwindSafe,
TIMER: RefUnwindSafe,

impl<TIMER, PINS> Send for Pwm<TIMER, PINS> where
PINS: Send,
TIMER: Send,

impl<TIMER, PINS> Sync for Pwm<TIMER, PINS> where
PINS: Sync,
TIMER: Sync,

impl<TIMER, PINS> Unpin for Pwm<TIMER, PINS> where
PINS: Unpin,
TIMER: Unpin,

impl<TIMER, PINS> UnwindSafe for Pwm<TIMER, PINS> where
PINS: UnwindSafe,
TIMER: UnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct gd32f1x0_hal::pwm::Pwm

Implementations

impl<TIMER: Deref<Target = RB>, RB: TimerIdleRegExt, PINS: Pins<TIMER>> Pwm<TIMER, PINS>

pub fn set_idle_state(&self, channel: Channel, idle_state: IdleState)

impl<TIMER: Deref<Target = RB>, RB: TimerIdleRegExt, PINS: Pins<TIMER> + ComplementaryPins> Pwm<TIMER, PINS>

pub fn set_complementary_idle_state( &self, channel: Channel, idle_state: IdleState)

impl<TIMER: Deref<Target = RB>, RB: TimerRegExt, PINS: Pins<TIMER>> Pwm<TIMER, PINS>

pub fn set_polarity(&self, channel: Channel, polarity: Polarity)

impl<TIMER: Deref<Target = RB>, RB: TimerRegExt, PINS: Pins<TIMER> + ComplementaryPins> Pwm<TIMER, PINS>

pub fn set_complementary_polarity(&self, channel: Channel, polarity: Polarity)

impl<P0, P1, P2, P3> Pwm<TIMER0, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

pub fn split( self) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>, Option<PwmChannel<TIMER0, P3>>)

impl<P0, P1, P2> Pwm<TIMER0, (Option<P0>, Option<P1>, Option<P2>)>

pub fn split( self) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>)

impl<PINS> Pwm<TIMER0, PINS> where PINS: Pins<TIMER0>,

pub fn stop(self) -> (Timer<TIMER0>, PINS)

pub fn set_alignment(&self, alignment: Alignment)

pub fn listen(&mut self, event: Event)

pub fn unlisten(&mut self, event: Event)

pub fn is_pending(&self, event: Event) -> bool

pub fn clear_interrupt_flag(&mut self, event: Event)

pub fn output_disable(&mut self)

pub fn automatic_output_enable(&mut self)

pub fn break_enable(&self, break_mode: BreakMode)

pub fn run_mode_off_state(&mut self, enabled: bool)

pub fn idle_mode_off_state(&mut self, enabled: bool)

pub fn set_dead_time(&self, dead_time: u16)

impl<P0, P1, P2, P3> Pwm<TIMER1, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

pub fn split( self) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>, Option<PwmChannel<TIMER1, P3>>)

impl<P0, P1, P2> Pwm<TIMER1, (Option<P0>, Option<P1>, Option<P2>)>

pub fn split( self) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>)

impl<PINS> Pwm<TIMER1, PINS> where PINS: Pins<TIMER1>,

pub fn stop(self) -> (Timer<TIMER1>, PINS)

pub fn set_alignment(&self, alignment: Alignment)

pub fn listen(&mut self, event: Event)

pub fn unlisten(&mut self, event: Event)

pub fn is_pending(&self, event: Event) -> bool

pub fn clear_interrupt_flag(&mut self, event: Event)

impl<P0, P1, P2, P3> Pwm<TIMER2, (Option<P0>, Option<P1>, Option<P2>, Option<P3>)>

pub fn split( self) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>, Option<PwmChannel<TIMER2, P3>>)

impl<P0, P1, P2> Pwm<TIMER2, (Option<P0>, Option<P1>, Option<P2>)>

pub fn split( self) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>)

impl<PINS> Pwm<TIMER2, PINS> where PINS: Pins<TIMER2>,

pub fn stop(self) -> (Timer<TIMER2>, PINS)

pub fn set_alignment(&self, alignment: Alignment)

pub fn listen(&mut self, event: Event)

pub fn unlisten(&mut self, event: Event)

pub fn is_pending(&self, event: Event) -> bool

pub fn clear_interrupt_flag(&mut self, event: Event)

Trait Implementations

impl<PINS> Pwm for Pwm<TIMER0, PINS> where PINS: Pins<TIMER0>,

type Channel = Channel

type Duty = u16

type Time = Hertz

fn disable(&mut self, channel: Self::Channel)

fn enable(&mut self, channel: Self::Channel)

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

fn get_max_duty(&self) -> Self::Duty

fn get_period(&self) -> Self::Time

fn set_period<T>(&mut self, period: T) where T: Into<Self::Time>,

impl<PINS> Pwm for Pwm<TIMER1, PINS> where PINS: Pins<TIMER1>,

type Channel = Channel

type Duty = u16

type Time = Hertz

fn disable(&mut self, channel: Self::Channel)

fn enable(&mut self, channel: Self::Channel)

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

fn get_max_duty(&self) -> Self::Duty

fn get_period(&self) -> Self::Time

fn set_period<T>(&mut self, period: T) where T: Into<Self::Time>,

impl<PINS> Pwm for Pwm<TIMER2, PINS> where PINS: Pins<TIMER2>,

type Channel = Channel

type Duty = u16

type Time = Hertz

fn disable(&mut self, channel: Self::Channel)

fn enable(&mut self, channel: Self::Channel)

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

pub fn set_complementary_idle_state(
&self,
channel: Channel,
idle_state: IdleState
)

pub fn split(
self
) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>, Option<PwmChannel<TIMER0, P3>>)

pub fn split(
self
) -> (Option<PwmChannel<TIMER0, P0>>, Option<PwmChannel<TIMER0, P1>>, Option<PwmChannel<TIMER0, P2>>)

impl<PINS> Pwm<TIMER0, PINS> where
PINS: Pins<TIMER0>,

pub fn split(
self
) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>, Option<PwmChannel<TIMER1, P3>>)

pub fn split(
self
) -> (Option<PwmChannel<TIMER1, P0>>, Option<PwmChannel<TIMER1, P1>>, Option<PwmChannel<TIMER1, P2>>)

impl<PINS> Pwm<TIMER1, PINS> where
PINS: Pins<TIMER1>,

pub fn split(
self
) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>, Option<PwmChannel<TIMER2, P3>>)

pub fn split(
self
) -> (Option<PwmChannel<TIMER2, P0>>, Option<PwmChannel<TIMER2, P1>>, Option<PwmChannel<TIMER2, P2>>)

impl<PINS> Pwm<TIMER2, PINS> where
PINS: Pins<TIMER2>,

impl<PINS> Pwm for Pwm<TIMER0, PINS> where
PINS: Pins<TIMER0>,

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

impl<PINS> Pwm for Pwm<TIMER1, PINS> where
PINS: Pins<TIMER1>,

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

impl<PINS> Pwm for Pwm<TIMER2, PINS> where
PINS: Pins<TIMER2>,

fn set_period<T>(&mut self, period: T) where
T: Into<Self::Time>,

impl<TIMER, PINS> RefUnwindSafe for Pwm<TIMER, PINS> where
PINS: RefUnwindSafe,
TIMER: RefUnwindSafe,

impl<TIMER, PINS> Send for Pwm<TIMER, PINS> where
PINS: Send,
TIMER: Send,

impl<TIMER, PINS> Sync for Pwm<TIMER, PINS> where
PINS: Sync,
TIMER: Sync,

impl<TIMER, PINS> Unpin for Pwm<TIMER, PINS> where
PINS: Unpin,
TIMER: Unpin,

impl<TIMER, PINS> UnwindSafe for Pwm<TIMER, PINS> where
PINS: UnwindSafe,
TIMER: UnwindSafe,

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

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

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

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

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

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