diff options
| author |  Alex Martens <alexmgit@protonmail.com>
| 2021-07-25 12:09:57 -0700 |
|---|---|---|
| committer | Alex Martens <alexmgit@protonmail.com>
| 2021-07-25 12:09:57 -0700 |
| commit | 7042622bfb844611c9cdbaf1196fa76362a32a6e (patch) | |
| tree | f8f348ff8fb221bcb4b56597424477751416f66e /src | |
| parent | 45e7ab72661a8823e98e8fba821f2addcea95d3f (diff) | |
| download | cortex-m-7042622bfb844611c9cdbaf1196fa76362a32a6e.tar.gz cortex-m-7042622bfb844611c9cdbaf1196fa76362a32a6e.tar.zst cortex-m-7042622bfb844611c9cdbaf1196fa76362a32a6e.zip | |
Add pre-requisites for enabling the cycle counter to docs
Diffstat (limited to 'src')
| -rw-r--r-- | src/peripheral/dwt.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/peripheral/dwt.rs b/src/peripheral/dwt.rs index 043223a..8e376a8 100644 --- a/src/peripheral/dwt.rs +++ b/src/peripheral/dwt.rs @@ -64,6 +64,13 @@ pub struct Comparator { impl DWT { /// Enables the cycle counter + /// + /// The global trace enable ([`DCB::enable_trace`]) should be set before + /// enabling the cycle counter, the processor may ignore writes to the + /// cycle counter enable if the global trace is disabled + /// (implementation defined behaviour). + /// + /// [`DCB::enable_trace`]: crate::peripheral::DCB::enable_trace #[cfg(not(armv6m))] #[inline] pub fn enable_cycle_counter(&mut self) { |