Merge pull request #545 from newAM/syst-example

Add SYST example
rust-embedded · Jul 1, 2024 · 52da23b · 52da23b
2 parents a97747f + 87ef4e6
commit 52da23b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/cortex-m/src/peripheral/syst.rs b/cortex-m/src/peripheral/syst.rs
@@ -1,4 +1,18 @@
 //! SysTick: System Timer
+//!
+//! # Example
+//!
+//! ```no_run
+//! use cortex_m::peripheral::{Peripherals, SYST};
+//!
+//! let core_periph = cortex_m::peripheral::Peripherals::take().unwrap();
+//! let mut syst = core_periph.SYST;
+//! syst.set_reload(0xffffff);
+//! syst.clear_current();
+//! syst.enable_counter();
+//!
+//! let syst_value: u32 = SYST::get_current();
+//! ```
 
 use volatile_register::{RO, RW};