rtc: split alarm value and enable into separate methods

Author: newAM

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `rcc::Lsco` to use the low-speed oscillator output.
 - Added `Rtc::calibrate_lp` to calibrate the RTC.
 - Added `Rtc::recalibration_pending`.
+- Added `Rtc::is_alarm_{a,b}_en`.
+
+## Changed
+- `Rtc.alarm_{a,b}` returns `Alarm` instead of `Option<Alarm>`.
 
 ### Fixed
 - Fixed a documentation bug in `rtc::Alarm`.  Values are masked if `true`, but the documentation indicated they are masked if `false`.

hal/src/rtc/mod.rs

@@ -576,18 +576,21 @@ impl Rtc {
         self.rtc.alrabinr.write(|w| w.ss().bits(alarm.ss));
     }
 
+    /// Returns `true` if alarm A is enabled.
+    #[inline]
+    #[must_use]
+    pub fn is_alarm_a_en(&self) -> bool {
+        self.rtc.cr.read().alrae().is_enabled()
+    }
+
     /// Get the value of alarm A.
-    ///
-    /// Returns `None` if the alarm is not set.
-    pub fn alarm_a(&self) -> Option<Alarm> {
-        if self.rtc.cr.read().alrae().is_disabled() {
-            None
-        } else {
-            Some(Alarm {
-                val: self.rtc.alrmar.read().bits(),
-                ss: self.rtc.alrabinr.read().ss().bits(),
-                ss_mask: self.rtc.alrmassr.read().maskss().bits(),
-            })
+    #[inline]
+    #[must_use]
+    pub fn alarm_a(&self) -> Alarm {
+        Alarm {
+            val: self.rtc.alrmar.read().bits(),
+            ss: self.rtc.alrabinr.read().ss().bits(),
+            ss_mask: self.rtc.alrmassr.read().maskss().bits(),
         }
     }
 
@@ -612,18 +615,21 @@ impl Rtc {
         self.rtc.alrbbinr.write(|w| w.ss().bits(alarm.ss));
     }
 
+    /// Returns `true` if alarm B is enabled.
+    #[inline]
+    #[must_use]
+    pub fn is_alarm_b_en(&self) -> bool {
+        self.rtc.cr.read().alrbe().is_enabled()
+    }
+
     /// Get the value of alarm B.
-    ///
-    /// Returns `None` if the alarm is not set.
-    pub fn alarm_b(&self) -> Option<Alarm> {
-        if self.rtc.cr.read().alrbe().is_disabled() {
-            None
-        } else {
-            Some(Alarm {
-                val: self.rtc.alrmbr.read().bits(),
-                ss: self.rtc.alrbbinr.read().ss().bits(),
-                ss_mask: self.rtc.alrmbssr.read().maskss().bits(),
-            })
+    #[inline]
+    #[must_use]
+    pub fn alarm_b(&self) -> Alarm {
+        Alarm {
+            val: self.rtc.alrmbr.read().bits(),
+            ss: self.rtc.alrbbinr.read().ss().bits(),
+            ss_mask: self.rtc.alrmbssr.read().maskss().bits(),
         }
     }
 

testsuite/src/rtc.rs

@@ -198,7 +198,7 @@ mod tests {
         while ta.rcc.bdcr.read().lserdy().is_not_ready() {}
         let mut rtc: Rtc = test_set_date_time_with_clk(rtc::Clk::Lse);
 
-        defmt::assert_eq!(rtc.alarm_a(), None);
+        defmt::assert!(!rtc.is_alarm_a_en());
 
         let alarm: Alarm = Alarm::from(unwrap!(rtc.time()) + Duration::seconds(1))
             .set_days_mask(true)
@@ -223,6 +223,7 @@ mod tests {
             }
         }
 
-        defmt::assert_eq!(rtc.alarm_a(), Some(alarm));
+        defmt::assert!(rtc.is_alarm_a_en());
+        defmt::assert_eq!(rtc.alarm_a(), alarm);
     }
 }