From 0e4998d2de1a9d8236b3d315eed08035e8de4d1f Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Tue, 25 Feb 2020 09:56:59 +0100 Subject: [PATCH] Improve documentation for alternate function modes --- src/gpio.rs | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/src/gpio.rs b/src/gpio.rs index acfe16c..4d075dd 100644 --- a/src/gpio.rs +++ b/src/gpio.rs @@ -21,17 +21,26 @@ trait GpioRegExt { fn set_low(&self, pos: u8); } +/// Alternate function 0 pub struct AF0; +/// Alternate function 1 pub struct AF1; +/// Alternate function 2 pub struct AF2; +/// Alternate function 3 pub struct AF3; +/// Alternate function 4 pub struct AF4; +/// Alternate function 5 pub struct AF5; +/// Alternate function 6 pub struct AF6; +/// Alternate function 7 pub struct AF7; -pub struct Alternate { - _mode: PhantomData, +/// Alternate function mode (type state) +pub struct Alternate { + _mode: PhantomData, } /// Input mode (type state) @@ -449,7 +458,7 @@ macro_rules! gpio { } } - impl $PXi> { + impl $PXi> { /// Enables / disables the internal pull up pub fn internal_pull_up(self, _cs: &CriticalSection, on: bool) -> Self { let offset = 2 * $i; @@ -464,7 +473,7 @@ macro_rules! gpio { } } - impl $PXi> { + impl $PXi> { /// Turns pin alternate configuration pin into open drain pub fn set_open_drain(self, _cs: &CriticalSection) -> Self { let offset = $i;