bsp: add RfSwitch::steal

Author: newAM

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added `Rtc::alarm_{a,b}` to get the alarm value.
 - Added `impl From<Alarm> for chrono::NaiveTime`.
+- Added `RfSwitch::steal()` to all BSPs.
 
 ## [0.5.0] - 2022-05-08
 ### Added

lora-e5-bsp/src/lib.rs

@@ -50,6 +50,47 @@ impl RfSwitch {
         }
     }
 
+    /// Steal the RF switch from whatever is currently using it.
+    ///
+    /// # Safety
+    ///
+    /// 1. Ensure that the code stealing the RF switch has exclusive access.
+    ///    Singleton checks are bypassed with this method.
+    /// 2. You must set up the RF switch pins.
+    ///    No setup will occur when using this method.
+    ///
+    /// # Example
+    ///
+    /// ```no_run
+    /// use lora_e5_bsp::{
+    ///     hal::{
+    ///         cortex_m,
+    ///         gpio::{pins, Output, PortA},
+    ///         pac,
+    ///     },
+    ///     RfSwitch,
+    /// };
+    ///
+    /// let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();
+    ///
+    /// let pa: PortA = PortA::split(dp.GPIOA, &mut dp.RCC);
+    /// cortex_m::interrupt::free(|cs| {
+    ///     let _: Output<pins::A4> = Output::default(pa.a4, cs);
+    ///     let _: Output<pins::A5> = Output::default(pa.a5, cs);
+    /// });
+    ///
+    /// // safety:
+    /// // 1. we have exclusive access to the underlying pins
+    /// // 2. the pins have been setup
+    /// let rfs: RfSwitch = unsafe { RfSwitch::steal() };
+    /// ```
+    pub unsafe fn steal() -> Self {
+        RfSwitch {
+            a4: Output::steal(),
+            a5: Output::steal(),
+        }
+    }
+
     /// Set the RF switch to receive.
     ///
     /// # Example

nucleo-wl55jc-bsp/src/lib.rs

@@ -53,6 +53,49 @@ impl RfSwitch {
         }
     }
 
+    /// Steal the RF switch from whatever is currently using it.
+    ///
+    /// # Safety
+    ///
+    /// 1. Ensure that the code stealing the RF switch has exclusive access.
+    ///    Singleton checks are bypassed with this method.
+    /// 2. You must set up the RF switch pins.
+    ///    No setup will occur when using this method.
+    ///
+    /// # Example
+    ///
+    /// ```no_run
+    /// use nucleo_wl55jc_bsp::{
+    ///     hal::{
+    ///         cortex_m,
+    ///         gpio::{pins, Output, PortC},
+    ///         pac,
+    ///     },
+    ///     RfSwitch,
+    /// };
+    ///
+    /// let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();
+    ///
+    /// let pc: PortC = PortC::split(dp.GPIOC, &mut dp.RCC);
+    /// cortex_m::interrupt::free(|cs| {
+    ///     let _: Output<pins::C3> = Output::default(pc.c3, cs);
+    ///     let _: Output<pins::C4> = Output::default(pc.c4, cs);
+    ///     let _: Output<pins::C5> = Output::default(pc.c5, cs);
+    /// });
+    ///
+    /// // safety:
+    /// // 1. we have exclusive access to the underlying pins
+    /// // 2. the pins have been setup
+    /// let rfs: RfSwitch = unsafe { RfSwitch::steal() };
+    /// ```
+    pub unsafe fn steal() -> Self {
+        RfSwitch {
+            fe_ctrl1: Output::steal(),
+            fe_ctrl2: Output::steal(),
+            fe_ctrl3: Output::steal(),
+        }
+    }
+
     /// Set the RF switch to receive.
     ///
     /// # Example