Embassy STM32 Timer

https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer
Admin
Embassy STM32 Timer is a comprehensive timer module for embedded Rust providing PWM, input capture,...
Tokens:38,294
Snippets:548
Trust Score:8.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize and Use RingBufferedPwmChannel

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/ringbuffered/struct.RingBufferedPwmChannel.html

Demonstrates how to convert a PWM channel into a ring-buffered channel, start the DMA transfer, and update duty cycles.

```rust
let mut channel = pwm.ch1().into_ring_buffered_channel(dma_ch, &mut buffer, Irqs);
channel.start(); // Start DMA transfer
channel.write(&[100, 200, 300]).ok(); // Update duty cycles
```

--------------------------------

### Implementations of GeneralInstance2Channel

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html

Examples of implementing the trait for various timer instances with their respective trigger interrupts.

```rust
impl GeneralInstance2Channel for TIM1 {
    type TriggerInterrupt = TIM1_BRK_UP_TRG_COM
}
```

```rust
impl GeneralInstance2Channel for TIM2 {
    type TriggerInterrupt = TIM2
}
```

```rust
impl GeneralInstance2Channel for TIM3 {
    type TriggerInterrupt = TIM3
}
```

```rust
impl GeneralInstance2Channel for TIM14 {
    type TriggerInterrupt = TIM14
}
```

```rust
impl GeneralInstance2Channel for TIM15 {
    type TriggerInterrupt = TIM15
}
```

```rust
impl GeneralInstance2Channel for TIM16 {
    type TriggerInterrupt = TIM16
}
```

```rust
impl GeneralInstance2Channel for TIM17 {
    type TriggerInterrupt = TIM17
}
```

--------------------------------

### current_duty_cycle()

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwmChannel.html?search=

Gets the current duty cycle value.

```APIDOC
## pub fn current_duty_cycle(&self) -> u16

### Description
Get the duty for a given channel. The value ranges from 0 for 0% duty, to `max_duty_cycle` for 100% duty, both included.
```

--------------------------------

### Qei Initialization Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/qei/struct.Qei.html?search=std%3A%3Avec

Methods to initialize the quadrature decoder with standard or advanced configurations.

```rust
pub fn new<CH1: QeiChannel, CH2: QeiChannel>( tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, CH1>>, ch2: Peri<'d, impl TimerPin<T, CH2>>, config: Config<T>, ) -> Self
```

```rust
pub fn new_advanced<CH1: QeiChannel, CH2: QeiChannel>( tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, CH1>>, ch2: Peri<'d, impl TimerPin<T, CH2>>, config: AdvancedConfig<T>, ) -> Self
```

--------------------------------

### Manage Off-State Selection

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Methods to get and set the OSSI and OSSR bits in the BDTR register.

```rust
pub fn set_off_state_selection_idle(&mut self, val: Ossi)
```

```rust
pub fn get_off_state_selection_idle(&self) -> Ossi
```

```rust
pub fn set_off_state_selection_run(&mut self, val: Ossr)
```

```rust
pub fn get_off_state_selection_run(&self) -> Ossr
```

--------------------------------

### Qei::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/qei/struct.Qei.html

Creates a new quadrature decoder driver instance with a standard configuration.

```APIDOC
## pub fn new<CH1: QeiChannel, CH2: QeiChannel>(tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, CH1>>, ch2: Peri<'d, impl TimerPin<T, CH2>>, config: Config<T>) -> Self

### Description
Initializes a new quadrature decoder driver using the specified timer peripheral, input pins, and configuration.

### Parameters
- **tim** (Peri<'d, T>) - The timer peripheral instance.
- **ch1** (Peri<'d, impl TimerPin<T, CH1>>) - The first encoder channel pin.
- **ch2** (Peri<'d, impl TimerPin<T, CH2>>) - The second encoder channel pin.
- **config** (Config<T>) - The configuration settings for the quadrature decoder.
```

--------------------------------

### SimplePwm::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwm.html

Creates a new simple PWM driver instance.

```APIDOC
## pub fn new(tim: Peri<'d, T>, ch1: Option<PwmPin<'d, T, Ch1>>, ch2: Option<PwmPin<'d, T, Ch2>>, ch3: Option<PwmPin<'d, T, Ch3>>, ch4: Option<PwmPin<'d, T, Ch4>>, freq: Hertz, counting_mode: CountingMode) -> Self

### Description
Creates a new simple PWM driver instance for the specified timer and pins.
```

--------------------------------

### Get AF Number for BreakInputPin

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/enum.BkIn1.html

Retrieves the alternate function number required to use a pin as a BreakInputPin.

```rust
fn af_num(&self) -> u8
```

--------------------------------

### setup_ring_buffer

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html

Sets up a ring buffer for the specified timer channel.

```APIDOC
## pub fn setup_ring_buffer<'a, W: Word + Into<T::Word>, D: UpDma<T>>( &mut self, dma: Peri<'a, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'a, channel: Channel, dma_buf: &'a mut [W], ) -> WritableRingBuffer<'a, W>

### Description
Setup a ring buffer for the channel.
```

--------------------------------

### InputCapture Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.InputCapture.html

Methods for initializing, configuring, and interacting with the InputCapture driver.

```APIDOC
## new
Creates a new input capture driver instance.

## enable(channel: Channel)
Enables the specified input capture channel.

## disable(channel: Channel)
Disables the specified input capture channel.

## is_enabled(channel: Channel) -> bool
Checks if the specified channel is enabled.

## set_input_capture_mode(channel: Channel, mode: InputCaptureMode)
Configures the capture mode for a channel.

## set_input_capture_selection(channel: Channel, icsel: InputCaptureSelection)
Sets the input capture selection.

## set_input_capture_filter(channel: Channel, filter: FilterValue)
Sets the input capture filter for a channel.

## set_input_capture_prescaler(channel: Channel, factor: u8)
Sets the input capture prescaler factor.

## get_capture_value(channel: Channel) -> T::Word
Retrieves the current capture value for a channel.

## get_input_interrupt(channel: Channel) -> bool
Checks the input interrupt status for a channel.
```

--------------------------------

### PwmPin::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.PwmPin.html

Creates a new PWM pin instance.

```APIDOC
## pub fn new(pin: Peri<'d, impl TimerPin<T, C>>, output_type: OutputType) -> Self

### Description
Creates a new PWM pin instance using the provided pin and output type.

### Parameters
- **pin** (Peri<'d, impl TimerPin<T, C>>) - The pin to be used for PWM.
- **output_type** (OutputType) - The configuration for the output type.
```

--------------------------------

### enable

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Enable the specified PWM channel.

```APIDOC
## pub fn enable(&mut self, channel: Channel)

### Description
Enable the given channel.
```

--------------------------------

### PwmPin::new_with_config

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.PwmPin.html

Creates a new PWM pin instance with a specific configuration.

```APIDOC
## pub fn new_with_config(pin: Peri<'d, impl TimerPin<T, C>>, pin_config: PwmPinConfig) -> Self

### Description
Creates a new PWM pin instance with a specific configuration object.

### Parameters
- **pin** (Peri<'d, impl TimerPin<T, C>>) - The pin to be used for PWM.
- **pin_config** (PwmPinConfig) - The configuration settings for the PWM pin.
```

--------------------------------

### setup_ring_buffer

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Configures a ring buffer for the specified timer channel using DMA.

```APIDOC
## pub fn setup_ring_buffer

### Description
Setup a ring buffer for the channel.

### Signature
`pub fn setup_ring_buffer<'a, W: Word + Into<T::Word>, D: UpDma<T>>( &mut self, dma: Peri<'a, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'a, channel: Channel, dma_buf: &'a mut [W], ) -> WritableRingBuffer<'a, W>`
```

--------------------------------

### new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/hall/struct.HallInterface.html

Creates and configures a new Hall sensor interface using the specified timer and pins.

```APIDOC
## pub fn new(tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, Ch1>>, ch2: Peri<'d, impl TimerPin<T, Ch2>>, ch3: Peri<'d, impl TimerPin<T, Ch3>>, config: HallConfig) -> Self

### Description
Initializes a Hall sensor interface on timer channels CH1, CH2, and CH3 with the provided configuration.

### Parameters
- **tim** (Peri<'d, T>) - The timer peripheral instance.
- **ch1** (Peri<'d, impl TimerPin<T, Ch1>>) - Pin for channel 1.
- **ch2** (Peri<'d, impl TimerPin<T, Ch2>>) - Pin for channel 2.
- **ch3** (Peri<'d, impl TimerPin<T, Ch3>>) - Pin for channel 3.
- **config** (HallConfig) - Configuration settings for the Hall sensor.
```

--------------------------------

### PwmInput::new_ch1

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/pwm_input/struct.PwmInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new PWM input driver instance for Channel 1.

```APIDOC
## pub fn new_ch1(tim: Peri<'d, T>, pin: Peri<'d, impl TimerPin<T, Ch1>>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, pull: Pull, freq: Hertz) -> Self
```

--------------------------------

### PwmPin Constructors

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.PwmPin.html?search=u32+-%3E+bool

Methods to initialize a new PwmPin instance with or without specific configuration.

```rust
pub fn new(pin: Peri<'d, impl TimerPin<T, C>>, output_type: OutputType) -> Self
```

```rust
pub fn new_with_config( pin: Peri<'d, impl TimerPin<T, C>>, pin_config: PwmPinConfig, ) -> Self
```

--------------------------------

### PwmInput Driver Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/pwm_input/struct.PwmInput.html?search=u32+-%3E+bool

Methods for initializing, controlling, and reading data from the PWM input driver.

```APIDOC
## PwmInput::new_ch1
### Description
Creates a new PWM input driver instance for channel 1.

## PwmInput::new_ch2
### Description
Creates a new PWM input driver instance for channel 2.

## PwmInput::enable
### Description
Enables the PWM input channel.

## PwmInput::disable
### Description
Disables the PWM input channel.

## PwmInput::is_enabled
### Description
Returns a boolean indicating whether the channel is currently enabled.

## PwmInput::get_period_ticks
### Description
Returns the measured period in timer ticks as a u32.

## PwmInput::get_width_ticks
### Description
Returns the measured pulse width in timer ticks as a u32.

## PwmInput::get_duty_cycle
### Description
Returns the duty cycle as an f32 (0.0 to 1.0).

## PwmInput::wait_for_period
### Description
Asynchronously waits for a rising edge to measure the period, returning the tick count as a u32.

## PwmInput::wait_for_width
### Description
Asynchronously waits for a falling edge to measure the pulse width, returning the tick count as a u32.
```

--------------------------------

### ComplementaryPwmPin::new_with_config

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwmPin.html

Creates a new instance of a complementary PWM pin with specific configuration.

```APIDOC
## fn new_with_config(pin: Peri<'d, impl TimerComplementaryPin<T, C>>, pin_config: PwmPinConfig) -> Self

### Description
Creates a new PWM pin instance with provided configuration.

### Parameters
- **pin** (Peri<'d, impl TimerComplementaryPin<T, C>>) - The pin to be used for PWM.
- **pin_config** (PwmPinConfig) - The configuration settings for the PWM pin.
```

--------------------------------

### setup_update_dma

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Generates a sequence of PWM waveforms using the update DMA channel.

```APIDOC
## pub fn setup_update_dma

### Description
Generate a sequence of PWM waveform. Note: you will need to provide corresponding TIMx_UP DMA channel to use this method.

### Signature
`pub fn setup_update_dma<'a, W: Word + Into<T::Word>, D: UpDma<T>>( &mut self, dma: Peri<'a, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'a, channel: Channel, duty: &'a [W], ) -> Transfer<'a>`
```

--------------------------------

### Qei::new_advanced

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/qei/struct.Qei.html

Creates a new quadrature decoder driver with extended encoder options.

```APIDOC
## pub fn new_advanced<CH1: QeiChannel, CH2: QeiChannel>(tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, CH1>>, ch2: Peri<'d, impl TimerPin<T, CH2>>, config: AdvancedConfig<T>) -> Self

### Description
Initializes a new quadrature decoder driver with advanced configuration options for specific encoder requirements.

### Parameters
- **tim** (Peri<'d, T>) - The timer peripheral instance.
- **ch1** (Peri<'d, impl TimerPin<T, CH1>>) - The first encoder channel pin.
- **ch2** (Peri<'d, impl TimerPin<T, CH2>>) - The second encoder channel pin.
- **config** (AdvancedConfig<T>) - The advanced configuration settings.
```

--------------------------------

### Implementations of AdvancedInstance1Channel

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.AdvancedInstance1Channel.html

Implementations for various timer instances including TIM1, TIM15, TIM16, and TIM17.

```rust
impl AdvancedInstance1Channel for TIM1 {
    type CommunicationInterrupt = TIM1_BRK_UP_TRG_COM;
    type BreakInputInterrupt = TIM1_BRK_UP_TRG_COM;
}
```

```rust
impl AdvancedInstance1Channel for TIM15 {
    type CommunicationInterrupt = TIM15;
    type BreakInputInterrupt = TIM15;
}
```

```rust
impl AdvancedInstance1Channel for TIM16 {
    type CommunicationInterrupt = TIM16;
    type BreakInputInterrupt = TIM16;
}
```

```rust
impl AdvancedInstance1Channel for TIM17 {
    type CommunicationInterrupt = TIM17;
    type BreakInputInterrupt = TIM17;
}
```

--------------------------------

### CloneToUninit Implementation

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/enum.BreakInputPolarity.html?search=std%3A%3Avec

Experimental nightly-only API for performing copy-assignment to uninitialized memory.

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

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

--------------------------------

### SimplePwmChannel Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwmChannel.html

Methods available for controlling a SimplePwmChannel instance.

```APIDOC
## enable()
Enable the PWM channel.

## disable()
Disable the PWM channel.

## is_enabled() -> bool
Check if the channel is currently enabled.

## get_frequency() -> Hertz
Get the configured frequency of the PWM channel.

## max_duty_cycle() -> u32
Get the maximum duty cycle value, which depends on the configured frequency and timer clock rate.

## set_duty_cycle(duty: u32)
Set the duty cycle for the channel. The value ranges from 0 (0%) to max_duty_cycle (100%).

## set_duty_cycle_fully_off()
Set the duty cycle to 0% (always inactive).

## set_duty_cycle_fully_on()
Set the duty cycle to 100% (always active).

## set_duty_cycle_fraction(num: u32, denom: u32)
Set the duty cycle to a fraction (num / denom). Ensure num <= denom and denom != 0.

## set_duty_cycle_percent(percent: u8)
Set the duty cycle as a percentage (0-100).

## current_duty_cycle() -> u16
Get the current duty cycle value.

## set_polarity(polarity: OutputPolarity)
Set the output polarity for the channel.

## set_output_compare_mode(mode: OutputCompareMode)
Set the output compare mode for the channel.

## set_output_compare_clear_enable(enable: bool)
Enable or disable OCREF clear for this channel.
```

--------------------------------

### PwmInput::new_ch2

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/pwm_input/struct.PwmInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new PWM input driver instance for Channel 2.

```APIDOC
## pub fn new_ch2(tim: Peri<'d, T>, pin: Peri<'d, impl TimerPin<T, Ch2>>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, pull: Pull, freq: Hertz) -> Self
```

--------------------------------

### Qei Operational Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/qei/struct.Qei.html?search=std%3A%3Avec

Methods for interacting with the quadrature decoder state.

```rust
pub fn read_direction(&self) -> Direction
```

```rust
pub fn count(&self) -> u32
```

```rust
pub fn reset(&mut self)
```

--------------------------------

### InputCaptureChannel Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.InputCaptureChannel.html?search=

Methods available for managing and interacting with an InputCaptureChannel instance.

```APIDOC
## pub fn enable(&mut self)
Enable this channel.

## pub fn disable(&mut self)
Disable this channel.

## pub fn is_enabled(&self) -> bool
Check whether this channel is enabled.

## pub fn set_input_capture_mode(&mut self, mode: InputCaptureMode)
Set the input capture mode for this channel.

## pub fn set_input_capture_selection(&mut self, icsel: InputCaptureSelection)
Set input capture selection for this channel.

## pub fn set_input_capture_filter(&mut self, filter: FilterValue)
Set the input capture filter for this channel.

## pub fn set_input_capture_prescaler(&mut self, factor: u8)
Set the input capture prescaler for this channel.

## pub fn get_capture_value(&self) -> T::Word
Get capture value for this channel.

## pub fn get_input_interrupt(&self) -> bool
Get input interrupt for this channel.

## pub async fn wait_for_rising_edge(&mut self) -> T::Word
Asynchronously wait until the pin or trigger sees a rising edge.

## pub async fn wait_for_falling_edge(&mut self) -> T::Word
Asynchronously wait until the pin or trigger sees a falling edge.

## pub async fn wait_for_any_edge(&mut self) -> T::Word
Asynchronously wait until the pin or trigger sees any edge.

## pub async fn wait_for_rising_edge_alternate(&mut self) -> T::Word
Asynchronously wait until the (alternate) pin or trigger sees a rising edge.

## pub async fn wait_for_falling_edge_alternate(&mut self) -> T::Word
Asynchronously wait until the (alternate) pin or trigger sees a falling edge.

## pub async fn wait_for_any_edge_alternate(&mut self) -> T::Word
Asynchronously wait until the (alternate) pin or trigger sees any edge.
```

--------------------------------

### setup_channel_update_dma

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html

Generates a sequence of PWM waveforms using a specific timer channel DMA.

```APIDOC
## pub fn setup_channel_update_dma<'a, C: TimerChannel, W: Word + Into<T::Word>, D: Dma<T, C>>( &mut self, dma: Peri<'a, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'a, channel: Channel, duty: &'a [W], ) -> Transfer<'a>

### Description
Generate a sequence of PWM waveform. Note: The DMA channel provided does not need to correspond to the requested channel.
```

--------------------------------

### setup_update_dma_burst

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html?search=std%3A%3Avec

Generates a multichannel sequence of PWM waveforms using DMA triggered by timer update events.

```APIDOC
## pub fn setup_update_dma_burst<'a, W: Word + Into<T::Word>, D: UpDma<T>>( &mut self, dma: Peri<'a, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'a, starting_channel: Channel, ending_channel: Channel, duty: &'a [W], ) -> Transfer<'a>

### Description
Generate a multichannel sequence of PWM waveforms using DMA triggered by timer update events. This method utilizes the timer’s DMA burst transfer capability to update multiple CCRx registers in sequence on each update event (UEV).
```

--------------------------------

### ComplementaryPwmPin::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwmPin.html

Creates a new instance of a complementary PWM pin.

```APIDOC
## fn new(pin: Peri<'d, impl TimerComplementaryPin<T, C>>, output_type: OutputType) -> Self

### Description
Creates a new complementary PWM pin instance.

### Parameters
- **pin** (Peri<'d, impl TimerComplementaryPin<T, C>>) - The pin to be used for PWM.
- **output_type** (OutputType) - The configuration for the output type.
```

--------------------------------

### CaptureInput Creation Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.CaptureInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to instantiate a CaptureInput from a pin or a trigger.

```rust
pub fn from_pin(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> Option<Self>
```

```rust
pub fn from_trigger(trigger: impl TimerInputTrigger<T, C>) -> Option<Self>
```

--------------------------------

### Implement GeneralInstance2Channel for TIM1

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM1 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM1 {
    type TriggerInterrupt = TIM1_BRK_UP_TRG_COM
}
```

--------------------------------

### Define Qei Config struct

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/qei/struct.Config.html

The configuration structure for the Qei driver, parameterized by the timer instance T.

```rust
pub struct Config<T: CoreInstance> {
    pub ch1_pull: Pull,
    pub ch2_pull: Pull,
    pub mode: QeiMode,
    pub auto_reload: T::Word,
}
```

--------------------------------

### ComplementaryPwm Constructor

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Initializes a new complementary PWM driver instance.

```rust
pub fn new( tim: Peri<'d, T>, ch1: Option<PwmPin<'d, T, Ch1>>, ch1n: Option<ComplementaryPwmPin<'d, T, Ch1>>, ch2: Option<PwmPin<'d, T, Ch2>>, ch2n: Option<ComplementaryPwmPin<'d, T, Ch2>>, ch3: Option<PwmPin<'d, T, Ch3>>, ch3n: Option<ComplementaryPwmPin<'d, T, Ch3>>, ch4: Option<PwmPin<'d, T, Ch4>>, ch4n: Option<ComplementaryPwmPin<'d, T, Ch4>>, freq: Hertz, counting_mode: CountingMode, ) -> Self
```

--------------------------------

### PWM Configuration Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html

Methods for configuring PWM frequency, period, and channel states.

```APIDOC
## set_frequency(freq: Hertz)
Sets the PWM frequency. Note that the frequency is applied upon the next update event.

## set_period_ms(ms: u32)
Sets the PWM period in milliseconds.

## set_period_us(us: u32)
Sets the PWM period in microseconds.

## set_period_secs(secs: u32)
Sets the PWM period in seconds.

## enable(channel: Channel)
Enables the specified PWM channel.

## disable(channel: Channel)
Disables the specified PWM channel.
```

--------------------------------

### Implement GeneralInstance2Channel for TIM3

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM3 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM3 {
    type TriggerInterrupt = TIM3
}
```

--------------------------------

### Implementations of GeneralInstance1Channel

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance1Channel.html

Implementations for various timer instances specifying their respective CaptureCompareInterrupt types.

```rust
impl GeneralInstance1Channel for TIM1 {
    type CaptureCompareInterrupt = TIM1_CC
}
```

```rust
impl GeneralInstance1Channel for TIM2 {
    type CaptureCompareInterrupt = TIM2
}
```

```rust
impl GeneralInstance1Channel for TIM3 {
    type CaptureCompareInterrupt = TIM3
}
```

```rust
impl GeneralInstance1Channel for TIM14 {
    type CaptureCompareInterrupt = TIM14
}
```

```rust
impl GeneralInstance1Channel for TIM15 {
    type CaptureCompareInterrupt = TIM15
}
```

```rust
impl GeneralInstance1Channel for TIM16 {
    type CaptureCompareInterrupt = TIM16
}
```

```rust
impl GeneralInstance1Channel for TIM17 {
    type CaptureCompareInterrupt = TIM17
}
```

--------------------------------

### Implement GeneralInstance2Channel for TIM15

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM15 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM15 {
    type TriggerInterrupt = TIM15
}
```

--------------------------------

### Break Input 2 Configuration

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html?search=

Methods for configuring comparator outputs and external pins as sources for break input 2.

```APIDOC
## pub fn set_break2_comparator_enable(&self, comp_index: usize, enable: bool)

### Description
Enable or disable a specific comparator output as a source for break input 2.

## pub fn get_break2_comparator_enable(&self, comp_index: usize) -> bool

### Description
Get the current enable state of a comparator as a break input 2 source.

## pub fn set_break2_comparator_polarity(&self, comp_index: usize, polarity: Bkinp)

### Description
Set the polarity for a comparator used as a break input 2 source.

## pub fn get_break2_comparator_polarity(&self, comp_index: usize) -> Bkinp

### Description
Get the current polarity configuration for a comparator break input 2 source.

## pub fn set_break2_input_pin_enable(&self, enable: bool)

### Description
Enable or disable the external BK2IN pin as a source for break input 2.

## pub fn get_break2_input_pin_enable(&self) -> bool

### Description
Get the current enable state of the external BK2IN pin.
```

--------------------------------

### ComplementaryPwmPin Constructors

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwmPin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to instantiate a new ComplementaryPwmPin, either with a basic output type or a full configuration.

```rust
pub fn new( pin: Peri<'d, impl TimerComplementaryPin<T, C>>, output_type: OutputType, ) -> Self
```

```rust
pub fn new_with_config( pin: Peri<'d, impl TimerComplementaryPin<T, C>>, pin_config: PwmPinConfig, ) -> Self
```

--------------------------------

### From and Into Conversion Implementations

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/enum.MasterMode.html?search=std%3A%3Avec

Standard library blanket implementations for type conversions.

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

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

```rust
fn into(self) -> U
```

--------------------------------

### HallInterface Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/hall/struct.HallInterface.html?search=std%3A%3Avec

Methods for creating the interface and managing Hall sensor events.

```rust
pub fn new( tim: Peri<'d, T>, ch1: Peri<'d, impl TimerPin<T, Ch1>>, ch2: Peri<'d, impl TimerPin<T, Ch2>>, ch3: Peri<'d, impl TimerPin<T, Ch3>>, config: HallConfig, ) -> Self
```

```rust
pub fn capture_ticks(&self) -> T::Word
```

```rust
pub fn event_pending(&self) -> bool
```

```rust
pub fn clear_event(&self)
```

--------------------------------

### Implement GeneralInstance2Channel for TIM17

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM17 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM17 {
    type TriggerInterrupt = TIM17
}
```

--------------------------------

### OnePulse Initialization Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.OnePulse.html?search=

Methods to initialize the OnePulse driver using different trigger sources.

```rust
pub fn new_ch1_edge_detect( tim: Peri<'d, T>, pin: TriggerPin<'d, T, Ch1>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, freq: Hertz, pulse_end: u32, counting_mode: CountingMode, ) -> Self
```

```rust
pub fn new_ch1( tim: Peri<'d, T>, _pin: TriggerPin<'d, T, Ch1>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, freq: Hertz, pulse_end: u32, counting_mode: CountingMode, capture_mode: InputCaptureMode, ) -> Self
```

```rust
pub fn new_ch2( tim: Peri<'d, T>, _pin: TriggerPin<'d, T, Ch2>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, freq: Hertz, pulse_end: u32, counting_mode: CountingMode, capture_mode: InputCaptureMode, ) -> Self
```

```rust
pub fn new_ext( tim: Peri<'d, T>, _pin: TriggerPin<'d, T, Ext>, _irq: impl Binding<T::CaptureCompareInterrupt, CaptureCompareInterruptHandler<T>> + 'd, freq: Hertz, pulse_end: u32, counting_mode: CountingMode, polarity: ExternalTriggerPolarity, ) -> Self
```

--------------------------------

### Implement GeneralInstance2Channel for TIM16

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM16 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM16 {
    type TriggerInterrupt = TIM16
}
```

--------------------------------

### Implement GeneralInstance2Channel for TIM2

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM2 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM2 {
    type TriggerInterrupt = TIM2
}
```

--------------------------------

### set_output_compare_preload

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/struct.Timer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Configures the output compare preload state for a channel.

```APIDOC
## pub fn set_output_compare_preload

### Description
Set output compare preload.

### Signature
`pub fn set_output_compare_preload(&self, channel: Channel, preload: bool)`
```

--------------------------------

### Implement GeneralInstance2Channel for TIM14

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance2Channel.html?search=std%3A%3Avec

Implementation for TIM14 specifying the TriggerInterrupt.

```rust
impl GeneralInstance2Channel for TIM14 {
    type TriggerInterrupt = TIM14
}
```

--------------------------------

### Advanced Timer Settings

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html

Methods for configuring master mode and automatic output features.

```APIDOC
## set_automatic_output_enable(enable: bool)
Configures the automatic output enable (AOE) feature.

## set_master_mode(mms: MasterMode)
Sets the Master Slave Mode.

## set_repetition_counter(val: u16)
Sets the repetition counter value.
```

--------------------------------

### OnePulse Configuration Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.OnePulse.html?search=std%3A%3Avec

Methods for managing pulse timing and trigger behavior.

```rust
pub fn pulse_end(&self) -> u32
```

```rust
pub fn set_pulse_end(&mut self, ticks: u32)
```

```rust
pub fn set_reset_on_trigger(&mut self, reset: bool)
```

--------------------------------

### Configure Idle Output States

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Methods for configuring the idle behavior of normal and complementary PWM channels.

```rust
pub fn set_output_idle_state( &mut self, channels: &[Channel], polarity: IdlePolarity, )
```

```rust
pub fn set_normal_output_idle_state( &mut self, channels: &[Channel], ois_active: bool, )
```

```rust
pub fn set_complementary_output_idle_state( &mut self, channels: &[Channel], oisn_active: bool, )
```

--------------------------------

### Implement GeneralInstance1Channel for Timers

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.GeneralInstance1Channel.html?search=u32+-%3E+bool

Implementations of the trait for various STM32 timer instances, mapping them to their respective capture-compare interrupts.

```rust
impl GeneralInstance1Channel for TIM1 {
	type CaptureCompareInterrupt = TIM1_CC;
}
```

```rust
impl GeneralInstance1Channel for TIM2 {
	type CaptureCompareInterrupt = TIM2;
}
```

```rust
impl GeneralInstance1Channel for TIM3 {
	type CaptureCompareInterrupt = TIM3;
}
```

```rust
impl GeneralInstance1Channel for TIM14 {
	type CaptureCompareInterrupt = TIM14;
}
```

```rust
impl GeneralInstance1Channel for TIM15 {
	type CaptureCompareInterrupt = TIM15;
}
```

```rust
impl GeneralInstance1Channel for TIM16 {
	type CaptureCompareInterrupt = TIM16;
}
```

```rust
impl GeneralInstance1Channel for TIM17 {
	type CaptureCompareInterrupt = TIM17;
}
```

--------------------------------

### Break Input 2 Configuration

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Methods for configuring the second break input.

```rust
pub fn set_break2_enable(&mut self, enable: bool)
```

```rust
pub fn get_break2_enable(&self) -> bool
```

```rust
pub fn set_break2_polarity(&mut self, polarity: BreakInputPolarity)
```

```rust
pub fn get_break2_polarity(&self) -> BreakInputPolarity
```

```rust
pub fn set_break2_filter(&mut self, filter: FilterValue)
```

```rust
pub fn get_break2_filter(&self) -> FilterValue
```

--------------------------------

### CapturePin::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.CapturePin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new capture pin instance. Note that this method is deprecated; users should use CaptureInput::from_pin instead.

```APIDOC
## pub fn new<'d, T: GeneralInstance4Channel, C: TimerChannel>(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> CaptureInput<'d, T, C>

### Description
Creates a new capture pin instance. This method is deprecated, and users are advised to use `CaptureInput::from_pin` instead.

### Parameters
- **pin** (Peri<'d, impl TimerPin<T, C>>) - Required - The timer pin to be used for input capture.
- **pull** (Pull) - Required - The pull configuration for the pin.

### Returns
- **CaptureInput<'d, T, C>** - An instance of the capture input.
```

--------------------------------

### Create a new Channel Trigger Pin

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.TriggerPin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a new instance of a channel trigger pin.

```rust
pub fn new(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> Self
```

--------------------------------

### CaptureInput::from_pin

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.CaptureInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new capture pin instance from a timer pin and a pull configuration.

```APIDOC
## pub fn from_pin(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> Option<Self>

### Description
Creates a new capture pin instance using the provided timer pin and pull configuration.

### Parameters
- **pin** (Peri<'d, impl TimerPin<T, C>>) - Required - The timer pin to be used for capture.
- **pull** (Pull) - Required - The pull configuration for the pin.
```

--------------------------------

### TryFrom and TryInto Conversion Implementations

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/low_level/enum.MasterMode.html?search=std%3A%3Avec

Standard library blanket implementations for fallible type conversions.

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

```rust
type Error = Infallible
```

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

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

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

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

--------------------------------

### RingBufferedPwmChannel Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/ringbuffered/struct.RingBufferedPwmChannel.html

Methods for controlling the ring buffer lifecycle and PWM configuration.

```APIDOC
## RingBufferedPwmChannel Methods

### start()
Starts the ring buffer operation. Must be called after initialization.

### clear()
Clears all data currently in the ring buffer.

### write(buf: &[W]) -> Result<(usize, usize), Error>
Writes elements from the provided buffer. Returns a tuple containing the length written and the remaining length.

### write_immediate(buf: &[W]) -> Result<(usize, usize), Error>
Writes elements directly to the raw buffer, useful for pre-filling before DMA starts.

### write_exact(buffer: &[W]) -> Result<usize, Error>
Asynchronously writes an exact number of elements to the ring buffer.

### stop()
Asynchronously stops the DMA transfer and waits until the buffer is empty.

### request_reset()
Requests a DMA reset. Configuration is not preserved.

### request_pause()
Requests the transfer to pause while maintaining existing configuration.

### is_running() -> bool
Returns true if the DMA transfer is currently active.

### set_polarity(polarity: OutputPolarity)
Sets the output polarity for the channel.

### set_output_compare_mode(mode: OutputCompareMode)
Sets the output compare mode for the channel.

### max_duty_cycle() -> u16
Returns the maximum duty cycle value based on current frequency and clock rate.
```

--------------------------------

### TriggerPin Constructor Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.TriggerPin.html

Methods for creating new instances of TriggerPin for channel or external triggers.

```rust
pub fn new(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> Self
```

```rust
pub fn new_external( pin: Peri<'d, impl ExternalTriggerPin<T>>, pull: Pull, ) -> Self
```

--------------------------------

### OnePulse Driver Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.OnePulse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for initializing and controlling the OnePulse driver.

```APIDOC
## OnePulse Initialization

### new_ch1_edge_detect
Creates a new one pulse driver triggered by channel 1 input pin on both rising and falling edges.

### new_ch1 / new_ch2 / new_ext
Creates a new one pulse driver triggered by specific input pins (Channel 1, Channel 2, or External Trigger).

## Pulse Configuration

### pulse_end(&self) -> u32
Returns the end of the pulse in ticks from the trigger.

### set_pulse_end(&mut self, ticks: u32)
Sets the end of the pulse in ticks from the trigger.

### set_reset_on_trigger(&mut self, reset: bool)
Configures whether the timer resets on each trigger.

## Channel Management

### channel(&mut self, channel: Channel) -> OnePulseChannel<'_, T>
Retrieves a single channel for output.

### ch1 / ch2 / ch3 / ch4
Convenience wrappers to access specific output channels.

### split(self) -> OnePulseChannels<'static, T>
Splits the OnePulse driver into four individual output channels.
```

--------------------------------

### PwmInput::enable / disable

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/pwm_input/struct.PwmInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to enable or disable the PWM input channel.

```APIDOC
## pub fn enable(&mut self)
## pub fn disable(&mut self)
```

--------------------------------

### Break Input 1 Configuration

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=

Methods for configuring the first break input, including enable, polarity, and digital filtering.

```rust
pub fn set_break_enable(&mut self, enable: bool)
```

```rust
pub fn get_break_enable(&self) -> bool
```

```rust
pub fn set_break_polarity(&mut self, polarity: BreakInputPolarity)
```

```rust
pub fn get_break_polarity(&self) -> BreakInputPolarity
```

```rust
pub fn set_break_filter(&mut self, filter: FilterValue)
```

```rust
pub fn get_break_filter(&self) -> FilterValue
```

--------------------------------

### Implement AdvancedInstance1Channel for TIM15

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.AdvancedInstance1Channel.html?search=std%3A%3Avec

Implementation of the trait for the TIM15 timer instance.

```rust
impl AdvancedInstance1Channel for TIM15 {
    type CommunicationInterrupt = TIM15;
    type BreakInputInterrupt = TIM15;
}
```

--------------------------------

### TriggerPin::new

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.TriggerPin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new Channel trigger pin instance for a timer.

```APIDOC
### pub fn new(pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull) -> Self

Creates a new Channel trigger pin instance. This allows a pin to be used as a trigger for a timer channel.
```

--------------------------------

### SimplePwmChannel PWM Control Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwmChannel.html?search=std%3A%3Avec

Methods available for controlling the duty cycle of a SimplePwmChannel instance.

```APIDOC
## fn max_duty_cycle(&self) -> u16

### Description
Returns the maximum duty cycle value supported by the timer.

## fn set_duty_cycle(&mut self, duty: u16) -> Result<(), Self::Error>

### Description
Sets the duty cycle to the specified value relative to the maximum duty cycle.

## fn set_duty_cycle_fully_off(&mut self) -> Result<(), Self::Error>

### Description
Sets the duty cycle to 0%, effectively turning the PWM output off.

## fn set_duty_cycle_fully_on(&mut self) -> Result<(), Self::Error>

### Description
Sets the duty cycle to 100%, effectively keeping the PWM output always active.

## fn set_duty_cycle_fraction(&mut self, num: u16, denom: u16) -> Result<(), Self::Error>

### Description
Sets the duty cycle to the fraction defined by num / denom.

## fn set_duty_cycle_percent(&mut self, percent: u8) -> Result<(), Self::Error>

### Description
Sets the duty cycle to the specified percentage (0-100).
```

--------------------------------

### Create a new CapturePin instance

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/input_capture/struct.CapturePin.html

Creates a new capture pin instance. Note that this method is deprecated; use CaptureInput::from_pin instead.

```rust
pub fn new<'d, T: GeneralInstance4Channel, C: TimerChannel>( pin: Peri<'d, impl TimerPin<T, C>>, pull: Pull, ) -> CaptureInput<'d, T, C>
```

--------------------------------

### Timer Pin Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/struct.Ch3.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods available for timer pins and complementary pins.

```APIDOC
## fn af_num(&self) -> u8

### Description
Get the AF (Alternate Function) number needed to use this pin as a `TimerPin` or `TimerComplementaryPin`.
```

--------------------------------

### Pwm Trait Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html?search=u32+-%3E+bool

Standard methods for interacting with PWM channels.

```APIDOC
## fn enable(&mut self, channel: Self::Channel)
Enables a PWM channel.

## fn disable(&mut self, channel: Self::Channel)
Disables a PWM channel.

## fn get_duty(&self, channel: Self::Channel) -> Self::Duty
Returns the current duty cycle for the specified channel.

## fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)
Sets a new duty cycle for the specified channel.

## fn get_period(&self) -> Self::Time
Returns the current PWM period.

## fn set_period<P>(&mut self, period: P)
Sets a new PWM period.
```

--------------------------------

### Implement AdvancedInstance1Channel for TIM1

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.AdvancedInstance1Channel.html?search=std%3A%3Avec

Implementation of the trait for the TIM1 timer instance.

```rust
impl AdvancedInstance1Channel for TIM1 {
    type CommunicationInterrupt = TIM1_BRK_UP_TRG_COM;
    type BreakInputInterrupt = TIM1_BRK_UP_TRG_COM;
}
```

--------------------------------

### waveform_up

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwm.html?search=std%3A%3Avec

Generates a sequence of PWM waveforms using a single DMA channel triggered by timer update events.

```APIDOC
## pub async fn waveform_up<W: Word + Into<T::Word>, D: UpDma<T>>(&mut self, dma: Peri<'_, D>, irq: impl Binding<D::Interrupt, InterruptHandler<D>> + '_, channel: Channel, duty: &[W])

### Description
Generates a sequence of PWM waveforms. Requires the corresponding TIMx_UP DMA channel.

### Parameters
- **dma** (Peri<'_, D>) - The DMA peripheral instance.
- **irq** (impl Binding<D::Interrupt, InterruptHandler<D>> + '_) - The interrupt binding for the DMA channel.
- **channel** (Channel) - The timer channel to use.
- **duty** (&[W]) - The sequence of duty cycle values.
```

--------------------------------

### Implement AdvancedInstance1Channel for TIM16

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.AdvancedInstance1Channel.html?search=std%3A%3Avec

Implementation of the trait for the TIM16 timer instance.

```rust
impl AdvancedInstance1Channel for TIM16 {
    type CommunicationInterrupt = TIM16;
    type BreakInputInterrupt = TIM16;
}
```

--------------------------------

### Borrow and BorrowMut Implementations

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/enum.BreakInputPolarity.html?search=std%3A%3Avec

Standard library implementations for immutable and mutable borrowing of owned values.

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

```rust
fn borrow(&self) -> &T
```

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

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

--------------------------------

### waveform_up

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html

Generates a sequence of PWM waveforms using the TIMx_UP DMA channel.

```APIDOC
## pub async fn waveform_up<W, D>(...)

### Description
Generates a sequence of PWM waveforms. Requires the use of the corresponding TIMx_UP DMA channel.
```

--------------------------------

### Implement AdvancedInstance1Channel for TIM17

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/trait.AdvancedInstance1Channel.html?search=std%3A%3Avec

Implementation of the trait for the TIM17 timer instance.

```rust
impl AdvancedInstance1Channel for TIM17 {
    type CommunicationInterrupt = TIM17;
    type BreakInputInterrupt = TIM17;
}
```

--------------------------------

### SimplePwm Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.SimplePwm.html?search=

Methods available for the SimplePwm driver to manage PWM channels, frequency, and periods.

```APIDOC
## pub fn new(tim, ch1, ch2, ch3, ch4, freq, counting_mode) -> Self
Creates a new simple PWM driver instance.

## pub fn channel(&mut self, channel: Channel) -> SimplePwmChannel<'_, T>
Retrieves a single PWM channel. Use this for individual channel control.

## pub fn split(self) -> SimplePwmChannels<'static, T>
Splits the PWM driver into four individual channels.

## pub fn set_frequency(&mut self, freq: Hertz)
Sets the PWM frequency. Note that the frequency is applied upon the next timer update event.

## pub fn get_frequency(&self) -> Hertz
Returns the currently configured PWM frequency.

## pub fn set_period(&mut self, period: Duration)
Sets the PWM period using an embassy_time::Duration.

## pub fn max_duty_cycle(&self) -> u32
Returns the maximum duty cycle value based on the current frequency and timer clock rate.

## pub async fn waveform<C, W, D>(&mut self, dma, irq, channel, duty)
Generates a sequence of PWM waveforms using DMA.
```

--------------------------------

### PwmPinConfig Struct Definition

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.PwmPinConfig.html

The structure used to configure PWM pin properties.

```rust
pub struct PwmPinConfig {
    pub output_type: OutputType,
    pub speed: Speed,
    pub pull: Pull,
}
```

--------------------------------

### PWM Control Methods

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/complementary_pwm/struct.ComplementaryPwm.html

Standard methods for enabling, disabling, and configuring PWM channels.

```APIDOC
## PWM Interface Methods

### enable(&mut self, channel: Self::Channel)
Enables a PWM channel.

### disable(&mut self, channel: Self::Channel)
Disables a PWM channel.

### set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)
Sets a new duty cycle for the specified channel.

### get_duty(&self, channel: Self::Channel) -> Self::Duty
Returns the current duty cycle for the specified channel.

### set_period<P>(&mut self, period: P)
Sets a new PWM period.

### get_period(&self) -> Self::Time
Returns the current PWM period.

### get_max_duty(&self) -> Self::Duty
Returns the maximum duty cycle value.
```

--------------------------------

### Define PwmInput Struct

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/pwm_input/struct.PwmInput.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The primary structure definition for the PWM input driver.

```rust
pub struct PwmInput<'d, T: GeneralInstance4Channel> { /* private fields */ }
```

--------------------------------

### Create a new External Trigger Pin

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/one_pulse/struct.TriggerPin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a new instance of an external trigger pin.

```rust
pub fn new_external( pin: Peri<'d, impl ExternalTriggerPin<T>>, pull: Pull, ) -> Self
```

--------------------------------

### PwmPin Struct Definition

Source: https://docs.embassy.dev/embassy-stm32/git/stm32c092kb/timer/simple_pwm/struct.PwmPin.html

The core structure definition for the PWM pin wrapper.

```rust
pub struct PwmPin<'d, T, C> { /* private fields */ }
```
Tokens:
Raw