Skip to content

Commit

Permalink
gpio: Clarify 'state' in set_fast() documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mciantyre committed Sep 23, 2020
1 parent 887a8e1 commit c8ff33f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions imxrt-hal/src/gpio.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,9 @@ where
/// Returns `false` if this pin does not support fast mode. Otherwise, returns `true`, indicating
/// that the setting was respected.
///
/// Note that the pin may be in a new state after transitioning into fast mode. Consider setting
/// and maintaining the fast mode setting before relying on the pin.
/// If you transition an output pin into fast mode, the GPIO output state may *not* be maintained.
/// That is, if your GPIO pin was high, a transition into fast mode may set the pin low. Consider
/// setting fast mode before driving the GPIO output to avoid inconsistencies.
pub fn set_fast(&mut self, fast: bool) -> bool {
self.gpr()
.map(|gpr| {
Expand Down

0 comments on commit c8ff33f

Please sign in to comment.