NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #2555 from eZioPan/timer-doc-fix

Browse source 
timer-doc-fix
This commit is contained in:
Dario Nieuwenhuis 2024-02-10 11:37:04 +00:00 committed by GitHub
commit edb3989b57
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
embassy-stm32/src/timer/mod.rs
View file

@ -1,6 +1,8 @@
//! Timers, PWM, quadrature decoder.
//!
//! Timer inheritance
//!
// sealed:
//
@ -14,16 +16,20 @@
// | +--------------------------------------|-----------+
// +----------------------------------------------------+
//! BasicInstance --> CaptureCompare16bitInstance --+--> ComplementaryCaptureCompare16bitInstance
//! |
//! +--> CaptureCompare32bitInstance
//! ```text
//! BasicInstance --> CaptureCompare16bitInstance --+--> ComplementaryCaptureCompare16bitInstance
//! |
//! +--> CaptureCompare32bitInstance
//! ```
//!
//! mapping:
//! Mapping:
//!
//! BasicInstance --> Basic Timer
//! CaptureCompare16bitInstance --> 1-channel Timer, 2-channel Timer, General Purpose 16-bit Timer
//! CaptureCompare32bitInstance --> General Purpose 32-bit Timer
//! ComplementaryCaptureCompare16bitInstance --> 1-channel with one complentary Timer, 2-channel with one complentary Timer, Advance Control Timer
//! | trait | timer |
//! | :----------------------------------------: | ------------------------------------------------------------------------------------------------- |
//! | [BasicInstance] | Basic Timer |
//! | [CaptureCompare16bitInstance] | 1-channel Timer, 2-channel Timer, General Purpose 16-bit Timer |
//! | [CaptureCompare32bitInstance] | General Purpose 32-bit Timer |
//! | [ComplementaryCaptureCompare16bitInstance] | 1-channel with one complentary Timer, 2-channel with one complentary Timer, Advance Control Timer |
#[cfg(not(stm32l0))]
pub mod complementary_pwm;