Merge pull request #850 from z-av/ptr-trait

improve Ptr trait & rename ErasedPin to AnyPin

Author: burrbull

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
  - Implement `embedded_hal::i2c::I2c` for `I2cMasterDma` [#838]
  - Back to `stm32f4`
  - Implement `Ptr`, `Sealed`, `Steal` for generic `Periph` [#834]
+ - Rename `ErasedPin` to `AnyPin` [#841]
  - Use `&mut RCC` for `PER::enable/reset`
  - Unmacro `Adc` [#832]
  - Use `write` instead of `modify` to clear flags [#829]
@@ -31,6 +32,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 [#834]: https://github.com/stm32-rs/stm32f4xx-hal/pull/834
 [#838]: https://github.com/stm32-rs/stm32f4xx-hal/pull/838
 [#839]: https://github.com/stm32-rs/stm32f4xx-hal/pull/839
+[#841]: https://github.com/stm32-rs/stm32f4xx-hal/pull/841
 
 ## [v0.22.1] - 2024-11-03
 

src/gpio.rs

@@ -401,8 +401,8 @@ impl<const P: char, const N: u8, MODE> Pin<P, N, MODE> {
     ///
     /// This is useful when you want to collect the pins into an array where you
     /// need all the elements to have the same type
-    pub fn erase(self) -> ErasedPin<MODE> {
-        ErasedPin::new(P as u8 - b'A', N)
+    pub fn erase(self) -> AnyPin<MODE> {
+        AnyPin::new(P as u8 - b'A', N)
     }
 }
 
@@ -415,7 +415,7 @@ impl<const P: char, const N: u8, MODE> From<Pin<P, N, MODE>> for PartiallyErased
     }
 }
 
-impl<const P: char, const N: u8, MODE> From<Pin<P, N, MODE>> for ErasedPin<MODE> {
+impl<const P: char, const N: u8, MODE> From<Pin<P, N, MODE>> for AnyPin<MODE> {
     /// Pin-to-erased pin conversion using the [`From`] trait.
     ///
     /// Note that [`From`] is the reciprocal of [`Into`].

src/gpio/convert.rs

@@ -166,8 +166,8 @@ macro_rules! change_mode {
 }
 use change_mode;
 
-use super::ErasedPin;
-impl<MODE: PinMode> ErasedPin<MODE> {
+use super::AnyPin;
+impl<MODE: PinMode> AnyPin<MODE> {
     #[inline(always)]
     pub(super) fn mode<M: PinMode>(&mut self) {
         let n = self.pin_id();
@@ -176,9 +176,9 @@ impl<MODE: PinMode> ErasedPin<MODE> {
 
     #[inline(always)]
     /// Converts pin into specified mode
-    pub fn into_mode<M: PinMode>(mut self) -> ErasedPin<M> {
+    pub fn into_mode<M: PinMode>(mut self) -> AnyPin<M> {
         self.mode::<M>();
-        ErasedPin::from_pin_port(self.into_pin_port())
+        AnyPin::from_pin_port(self.into_pin_port())
     }
 }
 

src/gpio/erased.rs

@@ -1,17 +1,17 @@
 use super::*;
 
-pub use ErasedPin as AnyPin;
+pub use AnyPin as ErasedPin;
 
 /// Fully erased pin
 ///
 /// `MODE` is one of the pin modes (see [Modes](crate::gpio#modes) section).
-pub struct ErasedPin<MODE> {
+pub struct AnyPin<MODE> {
     // Bits 0-3: Pin, Bits 4-7: Port
     pin_port: u8,
     _mode: PhantomData<MODE>,
 }
 
-impl<MODE> fmt::Debug for ErasedPin<MODE> {
+impl<MODE> fmt::Debug for AnyPin<MODE> {
     fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
         formatter.write_fmt(format_args!(
             "P({}{})<{}>",
@@ -23,7 +23,7 @@ impl<MODE> fmt::Debug for ErasedPin<MODE> {
 }
 
 #[cfg(feature = "defmt")]
-impl<MODE> defmt::Format for ErasedPin<MODE> {
+impl<MODE> defmt::Format for AnyPin<MODE> {
     fn format(&self, f: defmt::Formatter) {
         defmt::write!(
             f,
@@ -35,7 +35,7 @@ impl<MODE> defmt::Format for ErasedPin<MODE> {
     }
 }
 
-impl<MODE> PinExt for ErasedPin<MODE> {
+impl<MODE> PinExt for AnyPin<MODE> {
     type Mode = MODE;
 
     #[inline(always)]
@@ -48,7 +48,7 @@ impl<MODE> PinExt for ErasedPin<MODE> {
     }
 }
 
-impl<MODE> ErasedPin<MODE> {
+impl<MODE> AnyPin<MODE> {
     pub(crate) fn from_pin_port(pin_port: u8) -> Self {
         Self {
             pin_port,
@@ -93,23 +93,17 @@ impl<MODE> ErasedPin<MODE> {
     }
 }
 
-impl<MODE> ErasedPin<Output<MODE>> {
+impl<MODE> AnyPin<Output<MODE>> {
     /// Drives the pin high
     #[inline(always)]
     pub fn set_high(&mut self) {
-        // NOTE(unsafe) atomic write to a stateless register
-        unsafe { self.block().bsrr().write(|w| w.bits(1 << self.pin_id())) };
+        self.block().bsrr().write(|w| w.bs(self.pin_id()).set_bit());
     }
 
     /// Drives the pin low
     #[inline(always)]
     pub fn set_low(&mut self) {
-        // NOTE(unsafe) atomic write to a stateless register
-        unsafe {
-            self.block()
-                .bsrr()
-                .write(|w| w.bits(1 << (self.pin_id() + 16)))
-        };
+        self.block().bsrr().write(|w| w.br(self.pin_id()).set_bit());
     }
 
     /// Is the pin in drive high or low mode?
@@ -140,7 +134,7 @@ impl<MODE> ErasedPin<Output<MODE>> {
     /// Is the pin in drive low mode?
     #[inline(always)]
     pub fn is_set_low(&self) -> bool {
-        self.block().odr().read().bits() & (1 << self.pin_id()) == 0
+        self.block().odr().read().odr(self.pin_id()).bit_is_clear()
     }
 
     /// Toggle pin output
@@ -154,7 +148,7 @@ impl<MODE> ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> ErasedPin<MODE>
+impl<MODE> AnyPin<MODE>
 where
     MODE: marker::Readable,
 {
@@ -167,6 +161,6 @@ where
     /// Is the input pin low?
     #[inline(always)]
     pub fn is_low(&self) -> bool {
-        self.block().idr().read().bits() & (1 << self.pin_id()) == 0
+        self.block().idr().read().idr(self.pin_id()).bit_is_clear()
     }
 }

src/gpio/hal_02.rs

@@ -1,7 +1,7 @@
 use core::convert::Infallible;
 
 use super::{
-    dynamic::PinModeError, marker, DynamicPin, ErasedPin, Input, OpenDrain, Output,
+    dynamic::PinModeError, marker, AnyPin, DynamicPin, Input, OpenDrain, Output,
     PartiallyErasedPin, Pin, PinMode, PinState,
 };
 
@@ -107,7 +107,7 @@ where
 
 // Implementations for `ErasedPin`
 
-impl<MODE> OutputPin for ErasedPin<Output<MODE>> {
+impl<MODE> OutputPin for AnyPin<Output<MODE>> {
     type Error = core::convert::Infallible;
 
     #[inline(always)]
@@ -123,7 +123,7 @@ impl<MODE> OutputPin for ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> StatefulOutputPin for ErasedPin<Output<MODE>> {
+impl<MODE> StatefulOutputPin for AnyPin<Output<MODE>> {
     #[inline(always)]
     fn is_set_high(&self) -> Result<bool, Self::Error> {
         Ok(self.is_set_high())
@@ -135,7 +135,7 @@ impl<MODE> StatefulOutputPin for ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> ToggleableOutputPin for ErasedPin<Output<MODE>> {
+impl<MODE> ToggleableOutputPin for AnyPin<Output<MODE>> {
     type Error = Infallible;
 
     #[inline(always)]
@@ -145,7 +145,7 @@ impl<MODE> ToggleableOutputPin for ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> InputPin for ErasedPin<MODE>
+impl<MODE> InputPin for AnyPin<MODE>
 where
     MODE: marker::Readable,
 {

src/gpio/hal_1.rs

@@ -1,8 +1,6 @@
 use core::convert::Infallible;
 
-use super::{
-    dynamic::PinModeError, marker, DynamicPin, ErasedPin, Output, PartiallyErasedPin, Pin,
-};
+use super::{dynamic::PinModeError, marker, AnyPin, DynamicPin, Output, PartiallyErasedPin, Pin};
 
 use embedded_hal::digital::{ErrorType, InputPin, OutputPin, StatefulOutputPin};
 
@@ -53,11 +51,11 @@ where
 }
 
 // Implementations for `ErasedPin`
-impl<MODE> ErrorType for ErasedPin<MODE> {
+impl<MODE> ErrorType for AnyPin<MODE> {
     type Error = core::convert::Infallible;
 }
 
-impl<MODE> OutputPin for ErasedPin<Output<MODE>> {
+impl<MODE> OutputPin for AnyPin<Output<MODE>> {
     #[inline(always)]
     fn set_high(&mut self) -> Result<(), Self::Error> {
         self.set_high();
@@ -71,7 +69,7 @@ impl<MODE> OutputPin for ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> StatefulOutputPin for ErasedPin<Output<MODE>> {
+impl<MODE> StatefulOutputPin for AnyPin<Output<MODE>> {
     #[inline(always)]
     fn is_set_high(&mut self) -> Result<bool, Self::Error> {
         Ok(Self::is_set_high(self))
@@ -83,7 +81,7 @@ impl<MODE> StatefulOutputPin for ErasedPin<Output<MODE>> {
     }
 }
 
-impl<MODE> InputPin for ErasedPin<MODE>
+impl<MODE> InputPin for AnyPin<MODE>
 where
     MODE: marker::Readable,
 {

src/gpio/partially_erased.rs

@@ -68,18 +68,18 @@ impl<const P: char, MODE> PartiallyErasedPin<P, Output<MODE>> {
     #[inline(always)]
     pub fn set_high(&mut self) {
         // NOTE(unsafe) atomic write to a stateless register
-        unsafe {
-            (*gpiox::<P>()).bsrr().write(|w| w.bits(1 << self.i));
-        }
+        unsafe { &*gpiox::<P>() }
+            .bsrr()
+            .write(|w| w.bs(self.i).set_bit());
     }
 
     /// Drives the pin low
     #[inline(always)]
     pub fn set_low(&mut self) {
         // NOTE(unsafe) atomic write to a stateless register
-        unsafe {
-            (*gpiox::<P>()).bsrr().write(|w| w.bits(1 << (self.i + 16)));
-        }
+        unsafe { &*gpiox::<P>() }
+            .bsrr()
+            .write(|w| w.br(self.i).set_bit());
     }
 
     /// Is the pin in drive high or low mode?
@@ -111,7 +111,11 @@ impl<const P: char, MODE> PartiallyErasedPin<P, Output<MODE>> {
     #[inline(always)]
     pub fn is_set_low(&self) -> bool {
         // NOTE(unsafe) atomic read with no side effects
-        unsafe { (*gpiox::<P>()).odr().read().bits() & (1 << self.i) == 0 }
+        unsafe { &*gpiox::<P>() }
+            .odr()
+            .read()
+            .odr(self.i)
+            .bit_is_clear()
     }
 
     /// Toggle pin output
@@ -139,15 +143,19 @@ where
     #[inline(always)]
     pub fn is_low(&self) -> bool {
         // NOTE(unsafe) atomic read with no side effects
-        unsafe { (*gpiox::<P>()).idr().read().bits() & (1 << self.i) == 0 }
+        unsafe { &*gpiox::<P>() }
+            .idr()
+            .read()
+            .idr(self.i)
+            .bit_is_clear()
     }
 }
 
-impl<const P: char, MODE> From<PartiallyErasedPin<P, MODE>> for ErasedPin<MODE> {
+impl<const P: char, MODE> From<PartiallyErasedPin<P, MODE>> for AnyPin<MODE> {
     /// Partially erased pin-to-erased pin conversion using the [`From`] trait.
     ///
     /// Note that [`From`] is the reciprocal of [`Into`].
     fn from(p: PartiallyErasedPin<P, MODE>) -> Self {
-        ErasedPin::new(P as u8 - b'A', p.i)
+        AnyPin::new(P as u8 - b'A', p.i)
     }
 }

src/i2c/dma.rs

@@ -934,7 +934,7 @@ pub struct Rx<I2C> {
 unsafe impl<I2C: Instance> PeriAddress for Rx<I2C> {
     #[inline(always)]
     fn address(&self) -> u32 {
-        unsafe { (*I2C::ptr()).dr().as_ptr() as u32 }
+        unsafe { (*I2C::PTR).dr().as_ptr() as u32 }
     }
 
     type MemSize = u8;
@@ -943,7 +943,7 @@ unsafe impl<I2C: Instance> PeriAddress for Rx<I2C> {
 unsafe impl<I2C: Instance> PeriAddress for Tx<I2C> {
     #[inline(always)]
     fn address(&self) -> u32 {
-        unsafe { (*I2C::ptr()).dr().as_ptr() as u32 }
+        unsafe { (*I2C::PTR).dr().as_ptr() as u32 }
     }
 
     type MemSize = u8;

src/lib.rs

@@ -210,15 +210,18 @@ impl<RB, const A: usize> Sealed for Periph<RB, A> {}
 pub trait Ptr: Sealed {
     /// RegisterBlock structure
     type RB;
+    /// Pointer to the register block
+    const PTR: *const Self::RB;
     /// Return the pointer to the register block
-    fn ptr() -> *const Self::RB;
+    #[inline(always)]
+    fn ptr() -> *const Self::RB {
+        Self::PTR
+    }
 }
 
 impl<RB, const A: usize> Ptr for Periph<RB, A> {
     type RB = RB;
-    fn ptr() -> *const Self::RB {
-        Self::ptr()
-    }
+    const PTR: *const Self::RB = Self::PTR;
 }
 
 pub trait Steal: Sealed {
@@ -239,6 +242,7 @@ pub trait Steal: Sealed {
 }
 
 impl<RB, const A: usize> Steal for Periph<RB, A> {
+    #[inline(always)]
     unsafe fn steal() -> Self {
         Self::steal()
     }

src/serial.rs

@@ -139,7 +139,7 @@ pub trait Instance:
     #[doc(hidden)]
     #[inline(always)]
     fn peri_address() -> u32 {
-        unsafe { &*Self::ptr() }.peri_address()
+        unsafe { &*Self::PTR }.peri_address()
     }
 }