From 9020fc92d03701f7d2dbbac29434724ceb34072f Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sat, 6 Nov 2021 16:16:53 +0100 Subject: [PATCH] Refactored parts of the GPIO implementation --- Cargo.toml | 2 +- src/gpio.rs | 268 ++++++++++++++++++++++++++++--------------------- src/lib.rs | 2 +- src/prelude.rs | 4 + 4 files changed, 161 insertions(+), 115 deletions(-) create mode 100644 src/prelude.rs diff --git a/Cargo.toml b/Cargo.toml index d93dbf1..4f3d5a5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,7 +18,7 @@ nb = "1" embedded-hal = { features = ["unproven"], version = "0.2.6" } [dependencies.va108xx] -version = "0.1.0" +version = "0.1" [features] rt = ["va108xx/rt"] \ No newline at end of file diff --git a/src/gpio.rs b/src/gpio.rs index 7174f53..27e7b0b 100644 --- a/src/gpio.rs +++ b/src/gpio.rs @@ -1,7 +1,8 @@ use crate::pac::SYSCONFIG; use core::convert::Infallible; use core::marker::PhantomData; -use embedded_hal::digital::v2::{toggleable, InputPin, OutputPin, StatefulOutputPin}; +use embedded_hal::digital::v2::{InputPin, OutputPin, StatefulOutputPin, ToggleableOutputPin}; +use va108xx::IOCONFIG; /// Extension trait to split a GPIO peripheral in independent pins and registers pub trait GpioExt { @@ -9,14 +10,21 @@ pub trait GpioExt { type Parts; /// Splits the GPIO block into independent pins and registers. - fn split(self, syscfg: &mut SYSCONFIG) -> Self::Parts; + fn split(&mut self, syscfg: &mut SYSCONFIG) -> Self::Parts; +} + +#[derive(Debug, PartialEq)] +pub enum PinModeError { + InputDisabledForOutput, } trait GpioRegExt { fn is_low(&self, pos: u8) -> bool; - fn is_set_low(&self, pos: u8) -> bool; + fn is_set_low(&self, pos: usize, port_id: char) -> Result; + fn input_enabled_for_output(&self, pos: usize, port_id: char) -> bool; fn set_high(&self, pos: u8); fn set_low(&self, pos: u8); + fn toggle(&self, pos: u8); } /// Input mode (type state) @@ -77,10 +85,10 @@ pub enum FilterClkSel { /// Fully erased pin pub struct Pin { i: u8, + port_id: char, port: *const dyn GpioRegExt, _mode: PhantomData, } -unsafe impl Sync for Pin {} // NOTE(unsafe) this only enables read access to the same pin from multiple threads unsafe impl Send for Pin {} impl StatefulOutputPin for Pin> { @@ -90,11 +98,11 @@ impl StatefulOutputPin for Pin> { } #[inline(always)] fn is_set_low(&self) -> Result { - Ok(unsafe { (*self.port).is_set_low(self.i) }) + unsafe { (*self.port).is_set_low(self.i.into(), self.port_id) } } } impl OutputPin for Pin> { - type Error = Infallible; + type Error = PinModeError; #[inline(always)] fn set_high(&mut self) -> Result<(), Self::Error> { unsafe { (*self.port).set_high(self.i) }; @@ -106,7 +114,16 @@ impl OutputPin for Pin> { Ok(()) } } -impl toggleable::Default for Pin> {} + +impl ToggleableOutputPin for Pin> { + type Error = Infallible; + #[inline(always)] + fn toggle(&mut self) -> Result<(), Self::Error> { + unsafe { (*self.port).toggle(self.i) } + Ok(()) + } +} + impl InputPin for Pin> { type Error = Infallible; #[inline(always)] @@ -133,36 +150,59 @@ impl InputPin for Pin> { // This is only needs to be implemented for PORTA because PORTB is derived // from PORTA impl GpioRegExt for crate::pac::porta::RegisterBlock { + #[inline(always)] fn is_low(&self, pos: u8) -> bool { self.datainraw().read().bits() & (1 << pos) == 0 } - fn is_set_low(&self, pos: u8) -> bool { - // Note that this only works if the IENWO bit is enabled in IOCONFIG - // This is done by default for output pins for now - self.datainraw().read().bits() & (1 << pos) == 0 + #[inline(always)] + fn is_set_low(&self, pos: usize, port_id: char) -> Result { + if self.input_enabled_for_output(pos, port_id) { + Ok(self.datainraw().read().bits() & (1 << pos) == 0) + } else { + Err(PinModeError::InputDisabledForOutput) + } } + #[inline(always)] fn set_high(&self, pos: u8) { unsafe { self.setout().write(|w| w.bits(1 << pos)) } } + #[inline(always)] fn set_low(&self, pos: u8) { unsafe { self.clrout().write(|w| w.bits(1 << pos)) } } + #[inline(always)] + fn toggle(&self, pos: u8) { + unsafe { self.togout().write(|w| w.bits(1 << pos)) } + } + #[inline(always)] + fn input_enabled_for_output(&self, pos: usize, port_id: char) -> bool { + unsafe { + let iocfg = &(*IOCONFIG::ptr()); + match port_id { + 'A' => iocfg.porta[pos].read().iewo().bit_is_set(), + 'B' => iocfg.portb[pos].read().iewo().bit_is_set(), + _ => iocfg.porta[pos].read().iewo().bit_is_set(), + } + } + } } macro_rules! gpio { - ($PORTX:ident, $portx:ident, [ + ($PORTX:ident, $portx:ident, $port_id:expr, [ $($PXi:ident: ($pxi:ident, $i:expr),)+ ]) => { pub mod $portx { use core::marker::PhantomData; use core::convert::Infallible; - use cortex_m::interrupt::CriticalSection; use super::{ FUNSEL1, FUNSEL2, FUNSEL3, Floating, Funsel, GpioExt, Input, OpenDrain, - PullUp, Output, FilterType, FilterClkSel, Pin, GpioRegExt, PushPull + PullUp, Output, FilterType, FilterClkSel, Pin, GpioRegExt, PushPull, + PinModeError }; use crate::{pac::$PORTX, pac::SYSCONFIG, pac::IOCONFIG}; - use embedded_hal::digital::v2::{InputPin, OutputPin, StatefulOutputPin, toggleable}; + use embedded_hal::digital::v2::{ + InputPin, OutputPin, StatefulOutputPin, ToggleableOutputPin + }; pub struct Parts { $( pub $pxi: $PXi>, @@ -171,7 +211,7 @@ macro_rules! gpio { impl GpioExt for $PORTX { type Parts = Parts; - fn split(self, syscfg: &mut SYSCONFIG) -> Parts { + fn split(&mut self, syscfg: &mut SYSCONFIG) -> Parts { syscfg.peripheral_clk_enable.modify(|_, w| { w.$portx().set_bit(); w.gpio().set_bit(); @@ -186,10 +226,9 @@ macro_rules! gpio { } } - fn _set_alternate_mode(index: usize, mode: u8) { + fn _set_alternate_mode(iocfg: &mut IOCONFIG, index: usize, mode: u8) { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[index].modify(|_, w| { + iocfg.$portx[index].modify(|_, w| { w.funsel().bits(mode) }) } @@ -201,130 +240,120 @@ macro_rules! gpio { } impl $PXi { - pub fn into_funsel_1(self, _cs: &CriticalSection) -> $PXi> { - _set_alternate_mode(0, 1); + pub fn into_funsel_1(self, iocfg: &mut IOCONFIG) -> $PXi> { + _set_alternate_mode(iocfg, $i, 1); $PXi { _mode: PhantomData } } - pub fn into_funsel_2(self, _cs: &CriticalSection) -> $PXi> { - _set_alternate_mode(0, 2); + pub fn into_funsel_2(self, iocfg: &mut IOCONFIG) -> $PXi> { + _set_alternate_mode(iocfg, $i, 2); $PXi { _mode: PhantomData } } - pub fn into_funsel_3(self, _cs: &CriticalSection) -> $PXi> { - _set_alternate_mode(0, 3); + pub fn into_funsel_3(self, iocfg: &mut IOCONFIG) -> $PXi> { + _set_alternate_mode(iocfg, $i, 3); $PXi { _mode: PhantomData } } - pub fn into_floating_input(self, _cs: &CriticalSection) -> $PXi> { + pub fn into_floating_input( + self, iocfg: &mut IOCONFIG + ) -> $PXi> { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[0].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.funsel().bits(0); w.pen().clear_bit(); w.opendrn().clear_bit() }); let port_reg = &(*$PORTX::ptr()); - port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << 0))); + port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << $i))); } $PXi { _mode: PhantomData } } - pub fn into_pull_up_input(self, _cs: &CriticalSection) -> $PXi> { + pub fn into_pull_up_input(self, iocfg: &mut IOCONFIG) -> $PXi> { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[0].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.funsel().bits(0); w.pen().set_bit(); w.plevel().set_bit(); w.opendrn().clear_bit() }); let port_reg = &(*$PORTX::ptr()); - port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << 0))); + port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << $i))); } $PXi { _mode: PhantomData } } - pub fn into_pull_down_input(self, _cs: &CriticalSection) -> $PXi> { + pub fn into_pull_down_input( + self, iocfg: &mut IOCONFIG, port_reg: &mut $PORTX + ) -> $PXi> { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[0].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.funsel().bits(0); w.pen().set_bit(); w.plevel().clear_bit(); w.opendrn().clear_bit() }); - let port_reg = &(*$PORTX::ptr()); - port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << 0))); + port_reg.dir().modify(|r,w| w.bits(r.bits() & !(1 << $i))); } $PXi { _mode: PhantomData } } - pub fn into_open_drain_output(self, _cs: &CriticalSection) -> $PXi> { + pub fn into_open_drain_output( + self, iocfg: &mut IOCONFIG + ) -> $PXi> { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[$i].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.funsel().bits(0); w.pen().clear_bit(); w.opendrn().set_bit() }); let port_reg = &(*$PORTX::ptr()); - port_reg.dir().modify(|r,w| w.bits(r.bits() | (1 << 0))); + port_reg.dir().modify(|r,w| w.bits(r.bits() | (1 << $i))); } - let $pxi: $PXi> = $PXi { _mode: PhantomData }; - // Enable input functionality by default to ensure this is a stateful output pin - let $pxi = $pxi.enable_input(_cs, true); - $pxi + $PXi { _mode: PhantomData } } - pub fn into_push_pull_output(self, _cs: &CriticalSection) -> $PXi> { + pub fn into_push_pull_output( + self, iocfg: &mut IOCONFIG, port_reg: &mut $PORTX + ) -> $PXi> { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[$i].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.funsel().bits(0); w.opendrn().clear_bit() }); - let port_reg = &(*$PORTX::ptr()); - port_reg.dir().modify(|r,w| w.bits(r.bits() | (1 << 0))); + port_reg.dir().modify(|r,w| w.bits(r.bits() | (1 << $i))); } - let $pxi: $PXi> = $PXi { _mode: PhantomData }; - // Enable input functionality by default to ensure this is a stateful output pin - let $pxi = $pxi.enable_input(_cs, true); - $pxi + $PXi { _mode: PhantomData } } - pub fn filter_type(self, _cs: &CriticalSection, filter: FilterType, clksel: FilterClkSel) -> Self { + pub fn filter_type( + self, iocfg: &mut IOCONFIG, filter: FilterType, clksel: FilterClkSel + ) -> Self { unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[$i].modify(|_, w| { + iocfg.$portx[$i].modify(|_, w| { w.flttype().bits(filter as u8); w.fltclk().bits(clksel as u8) - }) + }); } self } } impl $PXi> { - pub fn input_inversion(self, _cs: &CriticalSection, enable: bool) -> Self { - unsafe { - let reg = &(*IOCONFIG::ptr()); - if enable { - reg.$portx[$i].modify(|_, w| w.invinp().set_bit()); - } else { - reg.$portx[$i].modify(|_, w| w.invinp().clear_bit()); - } + pub fn input_inversion(self, iocfg: &mut IOCONFIG, enable: bool) -> Self { + if enable { + iocfg.$portx[$i].modify(|_, w| w.invinp().set_bit()); + } else { + iocfg.$portx[$i].modify(|_, w| w.invinp().clear_bit()); } self } } impl $PXi> { - pub fn output_inversion(self, _cs: &CriticalSection, enable: bool) -> Self { - unsafe { - let reg = &(*IOCONFIG::ptr()); - if enable { - reg.$portx[$i].modify(|_, w| w.invout().set_bit()); - } else { - reg.$portx[$i].modify(|_, w| w.invout().clear_bit()); - } + pub fn output_inversion(self, iocfg: &mut IOCONFIG, enable: bool) -> Self { + if enable { + iocfg.$portx[$i].modify(|_, w| w.invout().set_bit()); + } else { + iocfg.$portx[$i].modify(|_, w| w.invout().clear_bit()); } self } @@ -333,52 +362,49 @@ macro_rules! gpio { /// this mode the input receiver is enabled even /// if the direction is configured as an output. /// This allows monitoring of output values - pub fn enable_input(self, _cs: &CriticalSection, enable: bool) -> Self { - unsafe { - let reg = &(*IOCONFIG::ptr()); - if enable { - reg.$portx[$i].modify(|_, w| w.iewo().set_bit()); - } else { - reg.$portx[$i].modify(|_, w| w.iewo().clear_bit()); - } + pub fn enable_input(self, iocfg: &mut IOCONFIG, enable: bool) -> Self { + if enable { + iocfg.$portx[$i].modify(|_, w| w.iewo().set_bit()); + } else { + iocfg.$portx[$i].modify(|_, w| w.iewo().clear_bit()); } self } - /// Enable Pull up/down even when output is active. The Default is to disable pull - /// up/down when output is actively driven. This bit enables the pull up/down all the time. + /// Enable Pull up/down even when output is active. The Default is to + /// disable pull up/down when output is actively driven. This bit enables the + /// pull up/down all the time. /// /// # Arguments /// /// `enable` - Enable the peripheral functionality /// `enable_pullup` - Enable the pullup itself - pub fn enable_pull_up(self, _cs: &CriticalSection, enable: bool, enable_pullup: bool) -> Self { - unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[$i].modify(|_, w| { - if enable { w.pwoa().set_bit(); } else { w.pwoa().clear_bit(); } - if enable_pullup { w.pen().set_bit(); } else { w.pen().clear_bit(); } - w.plevel().set_bit() - }); - } + pub fn enable_pull_up( + self, iocfg: &mut IOCONFIG, enable: bool, enable_pullup: bool + ) -> Self { + iocfg.$portx[$i].modify(|_, w| { + if enable { w.pwoa().set_bit(); } else { w.pwoa().clear_bit(); } + if enable_pullup { w.pen().set_bit(); } else { w.pen().clear_bit(); } + w.plevel().set_bit() + }); self } - /// Enable Pull up/down even when output is active. The Default is to disable pull - /// up/down when output is actively driven. This bit enables the pull up/down all the time. + /// Enable Pull up/down even when output is active. The Default is to disable + /// pull up/down when output is actively driven. This bit enables the + /// pull up/down all the time. /// /// # Arguments /// /// `enable` - Enable the peripheral functionality /// `enable_pullup` - Enable the pulldown itself - pub fn enable_pull_down(self, _cs: &CriticalSection, enable: bool, enable_pulldown: bool) -> Self { - unsafe { - let reg = &(*IOCONFIG::ptr()); - reg.$portx[$i].modify(|_, w| { - if enable { w.pwoa().set_bit(); } else { w.pwoa().clear_bit(); } - if enable_pulldown { w.pen().set_bit(); } else { w.pen().clear_bit(); } - w.plevel().clear_bit() - }); - } + pub fn enable_pull_down( + self, iocfg: &mut IOCONFIG, enable: bool, enable_pulldown: bool + ) -> Self { + iocfg.$portx[$i].modify(|_, w| { + if enable { w.pwoa().set_bit(); } else { w.pwoa().clear_bit(); } + if enable_pulldown { w.pen().set_bit(); } else { w.pen().clear_bit(); } + w.plevel().clear_bit() + }); self } } @@ -391,6 +417,7 @@ macro_rules! gpio { pub fn downgrade(self) -> Pin> { Pin { i: $i, + port_id: $port_id, port: $PORTX::ptr() as *const dyn GpioRegExt, _mode: self._mode, } @@ -398,23 +425,35 @@ macro_rules! gpio { } impl StatefulOutputPin for $PXi> { + #[inline(always)] fn is_set_high(&self) -> Result { self.is_set_low().map(|v| !v) } + #[inline(always)] fn is_set_low(&self) -> Result { - Ok(unsafe { (*$PORTX::ptr()).is_set_low(0) }) + unsafe { + (*$PORTX::ptr()).is_set_low($i, $port_id) + } } } impl OutputPin for $PXi> { - type Error = Infallible; + type Error = PinModeError; + #[inline(always)] fn set_high(&mut self) -> Result<(), Self::Error> { - Ok(unsafe { (*$PORTX::ptr()).set_high(0) }) + Ok(unsafe { (*$PORTX::ptr()).set_high($i) }) } + #[inline(always)] fn set_low(&mut self) -> Result<(), Self::Error> { - Ok(unsafe { (*$PORTX::ptr()).set_low(0) }) + Ok(unsafe { (*$PORTX::ptr()).set_low($i) }) + } + } + impl ToggleableOutputPin for $PXi> { + type Error = Infallible; + #[inline(always)] + fn toggle(&mut self) -> Result<(), Self::Error> { + Ok(unsafe { (*$PORTX::ptr()).toggle($i) }) } } - impl toggleable::Default for $PXi> {} impl $PXi> { /// Erases the pin number from the type /// @@ -423,6 +462,7 @@ macro_rules! gpio { pub fn downgrade(self) -> Pin> { Pin { i: $i, + port_id: $port_id, port: $PORTX::ptr() as *const dyn GpioRegExt, _mode: self._mode, } @@ -430,11 +470,13 @@ macro_rules! gpio { } impl InputPin for $PXi> { type Error = Infallible; + #[inline(always)] fn is_high(&self) -> Result { self.is_low().map(|v| !v) } + #[inline(always)] fn is_low(&self) -> Result { - Ok(unsafe { (*$PORTX::ptr()).is_low(0) }) + Ok(unsafe { (*$PORTX::ptr()).is_low($i) }) } } )+ @@ -442,7 +484,7 @@ macro_rules! gpio { } } -gpio!(PORTA, porta, [ +gpio!(PORTA, porta, 'A', [ PA0: (pa0, 0), PA1: (pa1, 1), PA2: (pa2, 2), @@ -477,7 +519,7 @@ gpio!(PORTA, porta, [ PA31: (pa31, 31), ]); -gpio!(PORTB, portb, [ +gpio!(PORTB, portb, 'B', [ PB0: (pb0, 0), PB1: (pb1, 1), PB2: (pb2, 2), diff --git a/src/lib.rs b/src/lib.rs index a8c2307..ccc7032 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -3,5 +3,5 @@ pub use va108xx; pub mod gpio; - +pub mod prelude; pub use va108xx as pac; diff --git a/src/prelude.rs b/src/prelude.rs new file mode 100644 index 0000000..6dacac5 --- /dev/null +++ b/src/prelude.rs @@ -0,0 +1,4 @@ +//! Prelude +pub use embedded_hal::prelude::*; + +pub use crate::gpio::GpioExt as _stm32h7xx_hal_gpio_GpioExt;