diff options
| author | Dario Nieuwenhuis <[email protected]> | 2023-12-18 19:11:13 +0100 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2023-12-18 19:11:23 +0100 |
| commit | 124478c5e9df16f0930d019c6f0db358666b3249 (patch) | |
| tree | 9c2ed7fe64b273efdd84f5952516b64a0b5f8566 /embassy-stm32/src/timer | |
| parent | 59d2977c0aef1104138473252fe8d84e3550e378 (diff) | |
stm32: more docs.
Diffstat (limited to 'embassy-stm32/src/timer')
| -rw-r--r-- | embassy-stm32/src/timer/complementary_pwm.rs | 2 | ||||
| -rw-r--r-- | embassy-stm32/src/timer/mod.rs | 3 | ||||
| -rw-r--r-- | embassy-stm32/src/timer/qei.rs | 2 | ||||
| -rw-r--r-- | embassy-stm32/src/timer/simple_pwm.rs | 2 |
4 files changed, 9 insertions, 0 deletions
diff --git a/embassy-stm32/src/timer/complementary_pwm.rs b/embassy-stm32/src/timer/complementary_pwm.rs index 6654366cd..e543a5b43 100644 --- a/embassy-stm32/src/timer/complementary_pwm.rs +++ b/embassy-stm32/src/timer/complementary_pwm.rs | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | //! PWM driver with complementary output support. | ||
| 2 | |||
| 1 | use core::marker::PhantomData; | 3 | use core::marker::PhantomData; |
| 2 | 4 | ||
| 3 | use embassy_hal_internal::{into_ref, PeripheralRef}; | 5 | use embassy_hal_internal::{into_ref, PeripheralRef}; |
diff --git a/embassy-stm32/src/timer/mod.rs b/embassy-stm32/src/timer/mod.rs index 9f93c6425..42ef878f7 100644 --- a/embassy-stm32/src/timer/mod.rs +++ b/embassy-stm32/src/timer/mod.rs | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | //! Timers, PWM, quadrature decoder. | ||
| 2 | |||
| 1 | pub mod complementary_pwm; | 3 | pub mod complementary_pwm; |
| 2 | pub mod qei; | 4 | pub mod qei; |
| 3 | pub mod simple_pwm; | 5 | pub mod simple_pwm; |
| @@ -8,6 +10,7 @@ use crate::interrupt; | |||
| 8 | use crate::rcc::RccPeripheral; | 10 | use crate::rcc::RccPeripheral; |
| 9 | use crate::time::Hertz; | 11 | use crate::time::Hertz; |
| 10 | 12 | ||
| 13 | /// Low-level timer access. | ||
| 11 | #[cfg(feature = "unstable-pac")] | 14 | #[cfg(feature = "unstable-pac")] |
| 12 | pub mod low_level { | 15 | pub mod low_level { |
| 13 | pub use super::sealed::*; | 16 | pub use super::sealed::*; |
diff --git a/embassy-stm32/src/timer/qei.rs b/embassy-stm32/src/timer/qei.rs index 01d028bf9..9f9379c20 100644 --- a/embassy-stm32/src/timer/qei.rs +++ b/embassy-stm32/src/timer/qei.rs | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | //! Quadrature decoder using a timer. | ||
| 2 | |||
| 1 | use core::marker::PhantomData; | 3 | use core::marker::PhantomData; |
| 2 | 4 | ||
| 3 | use embassy_hal_internal::{into_ref, PeripheralRef}; | 5 | use embassy_hal_internal::{into_ref, PeripheralRef}; |
diff --git a/embassy-stm32/src/timer/simple_pwm.rs b/embassy-stm32/src/timer/simple_pwm.rs index 1cf0ad728..234bbaff0 100644 --- a/embassy-stm32/src/timer/simple_pwm.rs +++ b/embassy-stm32/src/timer/simple_pwm.rs | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | //! Simple PWM driver. | ||
| 2 | |||
| 1 | use core::marker::PhantomData; | 3 | use core::marker::PhantomData; |
| 2 | 4 | ||
| 3 | use embassy_hal_internal::{into_ref, PeripheralRef}; | 5 | use embassy_hal_internal::{into_ref, PeripheralRef}; |
