Struct PwmCluster

pub struct PwmCluster<const NUM_PINS: usize, P, SM>
where
    P: PIOExt,
    SM: StateMachineIndex,
{ /* private fields */ }

A type to manage a cluster of PWM signals.

Implementations

impl<const NUM_PINS: usize, P, SM> PwmCluster<NUM_PINS, P, SM>

where P: PIOExt, SM: StateMachineIndex,

pub const CHANNEL_COUNT: usize = NUM_PINS

The number of channels used by this cluster.

pub const CHANNEL_PAIR_COUNT: usize

The number of channel pairs used by this cluster.

pub fn builder() -> PwmClusterBuilder<NUM_PINS, P>

Get a PwmClusterBuilder.

pub fn calculate_pwm_factors( system_clock_hz: HertzU32, freq: f32, ) -> Option<(u32, u32)>

Calculate the pwm factors (div and frac) from the system clock and desired frequency.

pub fn clock_divisor_fixed_point(&mut self, div: u16, frac: u8)

Set the clock divisor for this cluster.

pub fn channel_level(&self, channel: u8) -> Result<u32, PwmError>

The configured pwm level for the supplied channel.

pub fn set_channel_level( &mut self, channel: u8, level: u32, load: bool, ) -> Result<(), PwmError>

Set the pwm level for the supplied channel. If load is true, update the cluster’s data in the PIO state machine.

pub fn channel_offset(&self, channel: u8) -> Result<u32, PwmError>

pub fn set_channel_offset( &mut self, channel: u8, offset: u32, load: bool, ) -> Result<(), PwmError>

Set the start offset for the supplied channel. If load is true, update the cluster’s data in the PIO state machine.

pub fn channel_polarity(&self, channel: u8) -> Result<bool, PwmError>

pub fn set_channel_polarity( &mut self, channel: u8, polarity: bool, load: bool, ) -> Result<(), PwmError>

Set the polarity for the supplied channel. If load is true, update the cluster’s data in the PIO state machine.

pub fn top(&self) -> u32

Gets the top value for the pwm counter. This is equivalent to Slice::get_top when using [pac::PWM].

pub fn set_top(&mut self, top: u32, load_pwm: bool)

Set the top value for the supplied channel. If load is true, update the cluster’s data in the PIO state machine.

pub fn load_pwm(&mut self)

Load the pwm data into the PIO state machine.