Skip to content

Commit 7b2dbb0

Browse files
committed
itm: configure: note that peripheral is not relocked on Err
1 parent f2a1d92 commit 7b2dbb0

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/peripheral/itm.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,9 @@ impl ITM {
256256
self.tcr.read().busy()
257257
}
258258

259-
/// Tries to configure the [`ITM`] with the passed [`ITMConfiguration`].
259+
/// Tries to configure the [`ITM`] with the passed
260+
/// [`ITMConfiguration`]. Handles register unlocks. On `Err`, the
261+
/// [`ITM`] will not be relocked.
260262
#[allow(clippy::missing_inline_in_public_items)]
261263
pub fn configure(&mut self, settings: ITMConfiguration) -> Result<(), ITMConfigurationError> {
262264
use ITMConfigurationError as Error;

0 commit comments

Comments
 (0)