Skip to content

Commit

Permalink
clock/v2: Improve doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
glaeqen committed Jun 16, 2021
1 parent a7135ac commit 401fb8d
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions hal/src/thumbv7em/clock/v2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,15 @@ pub struct Tokens {
pub xosc32k: xosc32k::Xosc32kToken,
}

/// Standalone function returning a set of clocking components representing a
/// default state of clocking. In case of `thumbv7em` devices it is:
/// `Gclk0` powered by `DFLL48M` running in an open loop mode. Ultra-low power
/// internal 32k oscillator is always on.
/// Standalone function returning a set of instantiated clocking abstractions
/// representing a default state of a clocking system. For `thumbv7em` based
/// devices it is a chain of:
/// - [`dfll::Dfll<OpenLoop>`] (`48 MHz`)
/// - [`gclk::Gclk0<Dfll>`] (`48 MHz`)
///
/// And also ultra low power internal 32k oscillator:
///
/// - [`osculp32k::OscUlp32k`] (`32 KHz`)
pub fn retrieve_clocks(
oscctrl: OSCCTRL,
osc32kctrl: OSC32KCTRL,
Expand Down Expand Up @@ -123,9 +128,9 @@ pub fn retrieve_clocks(
///
/// These ones are essential during a construction (`fn ::{new, enable}`) and
/// deconstruction (`fn ::{free, disable}`) of clocking components as they
/// provide information to the constructed/deconstructed type what its source
/// is (shown in the example later) and which variant of source (associated
/// constant) is applicable while performing a HW register write.
/// provide information to the constructed/deconstructed type what its source is
/// and which variant of source (associated constant) is applicable while
/// performing a HW register write.
pub trait SourceMarker: crate::typelevel::Sealed {}

/// Supertrait unifying family of more specific source traits.
Expand Down

0 comments on commit 401fb8d

Please sign in to comment.