itm: document potentially altered fields on configuration errors

rust-embedded · Jan 4, 2022 · dc46425 · dc46425
1 parent c77e175
commit dc46425
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/peripheral/itm.rs b/src/peripheral/itm.rs
@@ -179,12 +179,20 @@ pub struct ITMSettings {
 pub enum ITMConfigurationError {
     /// Global timestamp generation is not supported on this target.
     /// Request [GlobalTimestampOptions::Disabled] instead.
+    ///
+    /// `ITM_TCR` register remains unchanged on this error.
     GTS,
     /// The requested timestamp clock source is not supported on this target.
+    ///
+    /// *NOTE*: `ITM_TCR.GTSFREQ` field has potentially been changed on
+    /// this error.
     TimestampClkSrc,
     /// The target does not implement the local timestamp prescaler.
     /// Request [LocalTimestampOptions::Disabled] or
     /// [LocalTimestampOptions::Disabled] instead.
+    ///
+    /// *NOTE*: `ITM_TCR.{GTSFREQ,SWOENA}` fields have potentially
+    /// changed on this error.
     TSPrescale,
 }