Skip to content

Commit dc46425

Browse files
committed
itm: document potentially altered fields on configuration errors
1 parent c77e175 commit dc46425

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/peripheral/itm.rs

+8
Original file line numberDiff line numberDiff line change
@@ -179,12 +179,20 @@ pub struct ITMSettings {
179179
pub enum ITMConfigurationError {
180180
/// Global timestamp generation is not supported on this target.
181181
/// Request [GlobalTimestampOptions::Disabled] instead.
182+
///
183+
/// `ITM_TCR` register remains unchanged on this error.
182184
GTS,
183185
/// The requested timestamp clock source is not supported on this target.
186+
///
187+
/// *NOTE*: `ITM_TCR.GTSFREQ` field has potentially been changed on
188+
/// this error.
184189
TimestampClkSrc,
185190
/// The target does not implement the local timestamp prescaler.
186191
/// Request [LocalTimestampOptions::Disabled] or
187192
/// [LocalTimestampOptions::Disabled] instead.
193+
///
194+
/// *NOTE*: `ITM_TCR.{GTSFREQ,SWOENA}` fields have potentially
195+
/// changed on this error.
188196
TSPrescale,
189197
}
190198

0 commit comments

Comments
 (0)