Merge upstream

Author: kalkyl

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 30
     continue-on-error: ${{ matrix.rust_version == 'nightly' }}
 
     steps:
@@ -34,7 +34,12 @@ jobs:
         thumbv8m.main-none-eabi
     - name: Build Crates
       run: cargo test -p xtask
+      env:
+        RUSTFLAGS: ${{ matrix.rustflags }}
 
     strategy:
       matrix:
-        rust_version: [stable, beta, nightly]
+        rust_version: [beta, nightly]
+        include:
+          - rust_version: stable
+            rustflags: --deny warnings

CHANGELOG.md

@@ -10,23 +10,42 @@
 - LPCOMP module ([#195]).
 - TWIS module ([#196]).
 - PWM module ([#200]).
-- I2S module ([#201]).
-- SPIS module ([#226]).
+- I2S module ([#201] [#209] [#225] [#237]).
+- SPIS module ([#226] [#236]).
 - Add support for the nRF52811 ([#227]).
+- Add PPI channel group tasks ([#212]).
+- Add PPI endpoints for timers ([#239]).
+
+### Enhancements
+
+- Improve SAADC docs ([#218]).
+- Update Embed.toml of all examples to new defaults ([#229]).
+- Make `ConfigurablePpi` and subtrait of `Ppi` ([#244]).
 
 ### Fixes
 
 - Refuse to build nRF52+ HALs for thumbv6m targets ([#203]).
 - Refuse to build `nrf52810-hal` for hard-float targets, and `nrf51-hal` for thumbv7+ targets
   ([#206]).
-- GPIOTE Port 1 and 0 differentiation for nRF52833 and nRF52840 ([#217])
+- Set the correct Port in GPIOTE ([#217] [#248]).
 - Correct TWIM port initialization for P1 pins ([#221]).
+- Fix race condition in RTC event handling ([#243]).
 
 ### Breaking Changes
 
-- Remove `Spi::read` ([#190]).
+- Remove `Spi::read` in favor of `transfer_split_uneven` ([#190]).
 - Seal the `timer::Instance` trait ([#214]).
-- Make GPIOs start in a `Disconnected` state instead of `Input<Floating>` ([#220]).
+- Make GPIOs start in a `Disconnected` state instead of `Input<Floating>` ([#220] [#245]).
+- 🦭 all `Instance` traits ([#255]).
+- 🦭 PPI traits ([#259]).
+- Various TWIM fixes and improvements - removes automatic transfer splitting ([#242]).
+- Remove typestate from RTC to make it easier to use ([#252]).
+- Also return owned `Pins` from `Usart::free()` ([#261]).
+
+### Internal Improvements
+
+- Utilize [`cargo-xtask`] to simplify CI and the release process ([#207] [#210]).
+- Add `conf()` utility function to reduce code duplication in GPIO ([#250]).
 
 [#185]: https://github.com/nrf-rs/nrf-hal/pull/185
 [#188]: https://github.com/nrf-rs/nrf-hal/pull/188
@@ -36,12 +55,35 @@
 [#200]: https://github.com/nrf-rs/nrf-hal/pull/200
 [#201]: https://github.com/nrf-rs/nrf-hal/pull/201
 [#203]: https://github.com/nrf-rs/nrf-hal/pull/203
+[#209]: https://github.com/nrf-rs/nrf-hal/pull/209
 [#190]: https://github.com/nrf-rs/nrf-hal/pull/190
 [#206]: https://github.com/nrf-rs/nrf-hal/pull/206
+[#207]: https://github.com/nrf-rs/nrf-hal/pull/207
+[#210]: https://github.com/nrf-rs/nrf-hal/pull/210
+[#212]: https://github.com/nrf-rs/nrf-hal/pull/212
 [#217]: https://github.com/nrf-rs/nrf-hal/pull/217
 [#214]: https://github.com/nrf-rs/nrf-hal/pull/214
+[#218]: https://github.com/nrf-rs/nrf-hal/pull/218
 [#220]: https://github.com/nrf-rs/nrf-hal/pull/220
 [#221]: https://github.com/nrf-rs/nrf-hal/pull/221
+[#225]: https://github.com/nrf-rs/nrf-hal/pull/225
+[#226]: https://github.com/nrf-rs/nrf-hal/pull/226
+[#227]: https://github.com/nrf-rs/nrf-hal/pull/227
+[#229]: https://github.com/nrf-rs/nrf-hal/pull/229
+[#236]: https://github.com/nrf-rs/nrf-hal/pull/236
+[#237]: https://github.com/nrf-rs/nrf-hal/pull/237
+[#239]: https://github.com/nrf-rs/nrf-hal/pull/239
+[#242]: https://github.com/nrf-rs/nrf-hal/pull/242
+[#243]: https://github.com/nrf-rs/nrf-hal/pull/243
+[#244]: https://github.com/nrf-rs/nrf-hal/pull/244
+[#245]: https://github.com/nrf-rs/nrf-hal/pull/245
+[#248]: https://github.com/nrf-rs/nrf-hal/pull/248
+[#250]: https://github.com/nrf-rs/nrf-hal/pull/250
+[#252]: https://github.com/nrf-rs/nrf-hal/pull/252
+[#255]: https://github.com/nrf-rs/nrf-hal/pull/255
+[#259]: https://github.com/nrf-rs/nrf-hal/pull/259
+[#261]: https://github.com/nrf-rs/nrf-hal/pull/261
+[`cargo-xtask`]: https://github.com/matklad/cargo-xtask
 
 ## [0.11.1]
 

examples/rtc-demo/src/main.rs

@@ -24,19 +24,19 @@ fn main() -> ! {
     let clocks = clocks.start_lfclk();
 
     // Run RTC for 1 second
-    let mut rtc = Rtc::new(p.RTC0);
+    let mut rtc = Rtc::new(p.RTC0, 0).unwrap();
     rtc.set_compare(RtcCompareReg::Compare0, 32_768).unwrap();
     rtc.enable_event(RtcInterrupt::Compare0);
 
     rprintln!("Starting RTC");
-    let rtc = rtc.enable_counter();
+    rtc.enable_counter();
 
     rprintln!("Waiting for compare match");
     while !rtc.is_event_triggered(RtcInterrupt::Compare0) {}
     rtc.reset_event(RtcInterrupt::Compare0);
 
     rprintln!("Compare match, stopping RTC");
-    let rtc = rtc.disable_counter();
+    rtc.disable_counter();
 
     rprintln!("Counter stopped at {} ticks", rtc.get_counter());
 

nrf-hal-common/src/gpio.rs

@@ -43,14 +43,22 @@ pub enum Port {
     Port1,
 }
 
+#[cfg(any(feature = "52833", feature = "52840"))]
 impl Port {
-    #[cfg(any(feature = "52833", feature = "52840"))]
     pub(crate) fn bit(&self) -> bool {
         match self {
             Port::Port0 => false,
             Port::Port1 => true,
         }
     }
+
+    pub(crate) fn from_bit(bit: bool) -> Port {
+        if bit {
+            Port::Port1
+        } else {
+            Port::Port0
+        }
+    }
 }
 
 // ===============================================================
@@ -81,7 +89,7 @@ use crate::hal::digital::v2::{InputPin, OutputPin, StatefulOutputPin};
 use void::Void;
 
 impl<MODE> Pin<MODE> {
-    fn new(port: Port, pin: u8) -> Self {
+    pub(crate) fn new(port: Port, pin: u8) -> Self {
         let port_bits = match port {
             Port::Port0 => 0x00,
             #[cfg(any(feature = "52833", feature = "52840"))]

nrf-hal-common/src/ppi/mod.rs

@@ -61,14 +61,17 @@ mod sealed {
     pub trait ChannelGroup {
         const CHG: usize;
     }
+
+    pub trait PpiSealed {}
+    pub trait PpiChannelGroupSealed {}
 }
-use sealed::{Channel, ChannelGroup, Event, NotFixed, Task};
+use sealed::{Channel, ChannelGroup, Event, NotFixed, PpiChannelGroupSealed, PpiSealed, Task};
 
 pub struct TaskAddr(pub(crate) u32);
 pub struct EventAddr(pub(crate) u32);
 
 /// Trait to represent a Programmable Peripheral Interconnect channel.
-pub trait Ppi {
+pub trait Ppi: PpiSealed {
     /// Enables the channel.
     fn enable(&mut self);
 
@@ -93,7 +96,7 @@ pub trait ConfigurablePpi: Ppi {
 }
 
 /// Trait for a PPI channel group.
-pub trait PpiChannelGroup {
+pub trait PpiChannelGroup: PpiChannelGroupSealed {
     /// Returns reference to `tasks_chg[x].en` endpoint for enabling channel group.
     fn task_enable(&self) -> &Reg<u32, _EN>;
     /// Returns reference to `tasks_chg[x].dis` endpoint for disabling channel group.
@@ -108,6 +111,7 @@ pub trait PpiChannelGroup {
 
 // All unsafe `ptr` calls only uses registers atomically, and only changes the resources owned by
 // the type (guaranteed by the abstraction).
+impl<P: Channel> PpiSealed for P {}
 impl<P: Channel> Ppi for P {
     #[inline(always)]
     fn enable(&mut self) {
@@ -151,6 +155,7 @@ impl<P: Channel + NotFixed> ConfigurablePpi for P {
     }
 }
 
+impl<G: ChannelGroup> PpiChannelGroupSealed for G {}
 impl<G: ChannelGroup> PpiChannelGroup for G {
     #[inline(always)]
     fn task_enable(&self) -> &Reg<u32, _EN> {

nrf-hal-common/src/pwm.rs

@@ -463,34 +463,6 @@ where
         self
     }
 
-    fn load_seq<B>(&self, seq: Seq, buf: B) -> Result<(), Error>
-    where
-        B: ReadBuffer<Word = u16> + 'static,
-    {
-        let (ptr, len) = unsafe { buf.read_buffer() };
-        if (ptr as usize) < SRAM_LOWER || (ptr as usize) > SRAM_UPPER {
-            return Err(Error::DMABufferNotInDataMemory);
-        }
-
-        if len > (1 << 15) / core::mem::size_of::<u16>() {
-            return Err(Error::BufferTooLong);
-        }
-
-        compiler_fence(Ordering::SeqCst);
-
-        match seq {
-            Seq::Seq0 => {
-                self.pwm.seq0.ptr.write(|w| unsafe { w.bits(ptr as u32) });
-                self.pwm.seq0.cnt.write(|w| unsafe { w.bits(len as u32) });
-            }
-            Seq::Seq1 => {
-                self.pwm.seq1.ptr.write(|w| unsafe { w.bits(ptr as u32) });
-                self.pwm.seq1.cnt.write(|w| unsafe { w.bits(len as u32) });
-            }
-        }
-        Ok(())
-    }
-
     /// Loads the first PWM value on all enabled channels from a sequence and starts playing that sequence.
     /// Causes PWM generation to start if not running.
     #[inline(always)]
@@ -1092,7 +1064,7 @@ pub enum Error {
     BufferTooLong,
 }
 
-pub trait Instance: private::Sealed + Deref<Target = crate::pac::pwm0::RegisterBlock> {
+pub trait Instance: sealed::Sealed + Deref<Target = crate::pac::pwm0::RegisterBlock> {
     const INTERRUPT: Interrupt;
 
     /// Provides access to the associated internal duty buffer for the instance.
@@ -1140,7 +1112,7 @@ impl Instance for PWM3 {
     }
 }
 
-mod private {
+mod sealed {
     pub trait Sealed {}
     impl Sealed for crate::pwm::PWM0 {}
 

nrf-hal-common/src/rtc.rs

@@ -11,29 +11,9 @@ use crate::pac::{rtc0, Interrupt, NVIC, RTC0, RTC1};
 #[cfg(any(feature = "52832", feature = "52833", feature = "52840"))]
 use crate::pac::RTC2;
 
-// Zero Size Type State structs
-
-/// The RTC has been stopped.
-pub struct Stopped;
-/// The RTC has been started.
-pub struct Started;
-
 /// An opaque high level interface to an RTC peripheral.
-pub struct Rtc<T, M> {
+pub struct Rtc<T> {
     periph: T,
-    _mode: M,
-}
-
-impl<T> Rtc<T, Stopped>
-where
-    T: Instance,
-{
-    pub fn new(rtc: T) -> Self {
-        Rtc {
-            periph: rtc,
-            _mode: Stopped,
-        }
-    }
 }
 
 /// Interrupts/Events that can be generated by the RTCn peripheral.
@@ -54,30 +34,34 @@ pub enum RtcCompareReg {
     Compare3,
 }
 
-impl<T, M> Rtc<T, M>
+impl<T> Rtc<T>
 where
     T: Instance,
 {
+    /// Creates a new RTC peripheral instance with a 12 bits prescaler.
+    /// fRTC = 32_768 / (`prescaler` + 1 )
+    pub fn new(rtc: T, prescaler: u32) -> Result<Self, Error> {
+        if prescaler >= (1 << 12) {
+            return Err(Error::PrescalerOutOfRange);
+        }
+
+        unsafe { rtc.prescaler.write(|w| w.bits(prescaler)) };
+
+        Ok(Rtc { periph: rtc })
+    }
+
     /// Enable/start the Real Time Counter.
-    pub fn enable_counter(self) -> Rtc<T, Started> {
+    pub fn enable_counter(&self) {
         unsafe {
             self.periph.tasks_start.write(|w| w.bits(1));
         }
-        Rtc {
-            periph: self.periph,
-            _mode: Started,
-        }
     }
 
     /// Disable/stop the Real Time Counter.
-    pub fn disable_counter(self) -> Rtc<T, Stopped> {
+    pub fn disable_counter(&self) {
         unsafe {
             self.periph.tasks_stop.write(|w| w.bits(1));
         }
-        Rtc {
-            periph: self.periph,
-            _mode: Stopped,
-        }
     }
 
     /// Enable the generation of a hardware interrupt from a given stimulus.
@@ -234,35 +218,23 @@ pub enum Error {
     CompareOutOfRange,
 }
 
-impl<T> Rtc<T, Stopped>
-where
-    T: Instance,
-{
-    /// Set the prescaler for the RTC peripheral. 12 bits of range.
-    /// fRTC = 32_768 / (`prescaler` + 1 )
-    pub fn set_prescaler(&mut self, prescaler: u32) -> Result<(), Error> {
-        if prescaler >= (1 << 12) {
-            return Err(Error::PrescalerOutOfRange);
-        }
-
-        unsafe { self.periph.prescaler.write(|w| w.bits(prescaler)) };
-
-        Ok(())
-    }
-}
-
 /// Implemented by all RTC instances.
-pub trait Instance: Deref<Target = rtc0::RegisterBlock> {
+pub trait Instance: Deref<Target = rtc0::RegisterBlock> + sealed::Sealed {
     /// The interrupt associated with this RTC instance.
     const INTERRUPT: Interrupt;
 }
 
+mod sealed {
+    pub trait Sealed {}
+}
+
 macro_rules! impl_instance {
     ($($name:ident,)*) => {
         $(
             impl Instance for $name {
                 const INTERRUPT: Interrupt = Interrupt::$name;
             }
+            impl sealed::Sealed for $name {}
         )*
     }
 }

nrf-hal-common/src/spi.rs

@@ -128,8 +128,14 @@ pub enum Error {
 }
 
 /// Trait implemented by all SPI peripheral instances.
-pub trait Instance: Deref<Target = spi0::RegisterBlock> {}
+pub trait Instance: Deref<Target = spi0::RegisterBlock> + sealed::Sealed {}
 
+mod sealed {
+    pub trait Sealed {}
+}
+
+impl sealed::Sealed for SPI0 {}
 impl Instance for SPI0 {}
 
+impl sealed::Sealed for SPI1 {}
 impl Instance for SPI1 {}