aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreZio Pan <[email protected]>2024-02-10 15:58:56 +0800
committereZio Pan <[email protected]>2024-02-10 16:22:36 +0800
commitb4399a1bf56403a8a3204e440fb1b9295bb2a137 (patch)
treec1b03df1c89e4dfbcadcab2c51d1c7f8fbf93f82
parentf0ffc9f74accbf952995b844d14d17d7dc822ac4 (diff)
timer-doc-fix
-rw-r--r--embassy-stm32/src/timer/mod.rs22
1 files changed, 14 insertions, 8 deletions
diff --git a/embassy-stm32/src/timer/mod.rs b/embassy-stm32/src/timer/mod.rs
index 0118395a7..9480d6972 100644
--- a/embassy-stm32/src/timer/mod.rs
+++ b/embassy-stm32/src/timer/mod.rs
@@ -1,6 +1,8 @@
1//! Timers, PWM, quadrature decoder. 1//! Timers, PWM, quadrature decoder.
2//!
2 3
3//! Timer inheritance 4//! Timer inheritance
5//!
4 6
5// sealed: 7// sealed:
6// 8//
@@ -14,16 +16,20 @@
14// | +--------------------------------------|-----------+ 16// | +--------------------------------------|-----------+
15// +----------------------------------------------------+ 17// +----------------------------------------------------+
16 18
17//! BasicInstance --> CaptureCompare16bitInstance --+--> ComplementaryCaptureCompare16bitInstance 19//! ```text
18//! | 20//! BasicInstance --> CaptureCompare16bitInstance --+--> ComplementaryCaptureCompare16bitInstance
19//! +--> CaptureCompare32bitInstance 21//! |
22//! +--> CaptureCompare32bitInstance
23//! ```
20//! 24//!
21//! mapping: 25//! Mapping:
22//! 26//!
23//! BasicInstance --> Basic Timer 27//! | trait | timer |
24//! CaptureCompare16bitInstance --> 1-channel Timer, 2-channel Timer, General Purpose 16-bit Timer 28//! | :----------------------------------------: | ------------------------------------------------------------------------------------------------- |
25//! CaptureCompare32bitInstance --> General Purpose 32-bit Timer 29//! | [BasicInstance] | Basic Timer |
26//! ComplementaryCaptureCompare16bitInstance --> 1-channel with one complentary Timer, 2-channel with one complentary Timer, Advance Control Timer 30//! | [CaptureCompare16bitInstance] | 1-channel Timer, 2-channel Timer, General Purpose 16-bit Timer |
31//! | [CaptureCompare32bitInstance] | General Purpose 32-bit Timer |
32//! | [ComplementaryCaptureCompare16bitInstance] | 1-channel with one complentary Timer, 2-channel with one complentary Timer, Advance Control Timer |
27 33
28#[cfg(not(stm32l0))] 34#[cfg(not(stm32l0))]
29pub mod complementary_pwm; 35pub mod complementary_pwm;