Merge #366

366: Add nrf5340-app-hal r=jonas-schievink a=sphw

This PR adds a HAL for the nRF5340's app core. It is more or less identical to the nRF9160 HAL that already exists, with some features added or removed for the nRF5340. I have not added support for the net core yet, as I don't need it for my use case. 

Co-authored-by: Sascha Wise <[email protected]>
Co-authored-by: Jonas Schievink <[email protected]>

Author: 3 people

Cargo.ci.toml

@@ -7,6 +7,7 @@ members = [
   "nrf52833-hal",
   "nrf52840-hal",
   "nrf52840-hal-tests",
+  "nrf5340-app-hal",
   "nrf9160-hal",
   "examples/*",
 ]

nrf-hal-common/Cargo.toml

@@ -60,6 +60,10 @@ version = "0.10.1"
 optional = true
 version = "0.10.1"
 
+[dependencies.nrf5340-app-pac]
+optional = true
+version = "0.10.1"
+
 [dependencies.nrf9160-pac]
 optional = true
 version = "0.10.1"
@@ -80,4 +84,5 @@ doc = []
 52832 = ["nrf52832-pac"]
 52833 = ["nrf52833-pac", "nrf-usbd"]
 52840 = ["nrf52840-pac", "nrf-usbd"]
+5340-app = ["nrf5340-app-pac"]
 9160 = ["nrf9160-pac"]

nrf-hal-common/src/clocks.rs

@@ -1,9 +1,9 @@
 //! Configuration and control of the High and Low Frequency Clock sources.
 
-#[cfg(feature = "9160")]
+#[cfg(any(feature = "9160", feature = "5340-app"))]
 use crate::pac::CLOCK_NS as CLOCK;
 
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 use crate::pac::CLOCK;
 
 // ZST Type States
@@ -156,7 +156,7 @@ impl<H, L> Clocks<H, L, LfOscStopped> {
     }
 
     /// Use the internal RC Oscillator for the low frequency clock source.
-    #[cfg(not(any(feature = "9160", feature = "51")))]
+    #[cfg(not(any(feature = "9160", feature = "5340-app", feature = "51")))]
     pub fn set_lfclk_src_rc(self) -> Clocks<H, Internal, LfOscStopped> {
         self.periph
             .lfclksrc
@@ -170,7 +170,7 @@ impl<H, L> Clocks<H, L, LfOscStopped> {
     }
 
     /// Generate the Low Frequency clock from the high frequency clock source.
-    #[cfg(not(any(feature = "9160", feature = "51")))]
+    #[cfg(not(any(feature = "9160", feature = "5340-app", feature = "51")))]
     pub fn set_lfclk_src_synth(self) -> Clocks<H, LfOscSynthesized, LfOscStopped> {
         self.periph
             .lfclksrc
@@ -184,7 +184,7 @@ impl<H, L> Clocks<H, L, LfOscStopped> {
     }
 
     /// Use an external crystal to drive the low frequency clock.
-    #[cfg(not(any(feature = "9160", feature = "51")))]
+    #[cfg(not(any(feature = "9160", feature = "5340-app", feature = "51")))]
     pub fn set_lfclk_src_external(
         self,
         cfg: LfOscConfiguration,

nrf-hal-common/src/comp.rs

@@ -4,14 +4,17 @@
 //! Vin can be derived from an analog input pin (AIN0-AIN7).
 //! Vref can be derived from multiple sources depending on the operation mode of the comparator.
 
-use {
-    crate::gpio::{p0::*, Floating, Input},
-    crate::pac::{
-        comp::{extrefsel::EXTREFSEL_A, psel::PSEL_A, EVENTS_CROSS, EVENTS_DOWN, EVENTS_UP},
-        COMP,
-    },
+use crate::gpio::{p0::*, Floating, Input};
+#[cfg(not(feature = "5340-app"))]
+use crate::pac::comp::{
+    extrefsel::EXTREFSEL_A, psel::PSEL_A, EVENTS_CROSS, EVENTS_DOWN, EVENTS_UP,
 };
+use crate::pac::COMP;
 
+#[cfg(feature = "5340-app")]
+use crate::pac::comp_ns::{
+    extrefsel::EXTREFSEL_A, psel::PSEL_A, EVENTS_CROSS, EVENTS_DOWN, EVENTS_UP,
+};
 /// A safe wrapper around the `COMP` peripheral.
 pub struct Comp {
     comp: COMP,

nrf-hal-common/src/gpio.rs

@@ -37,6 +37,9 @@ pub enum Level {
 pub enum Port {
     /// Port 0, available on all nRF52 and nRF51 MCUs.
     Port0,
+    /// Port 0 Secure, available on nRF53
+    #[cfg(any(feature = "5340-app"))]
+    Port0Secure,
 
     /// Port 1, only available on some nRF52 MCUs.
     #[cfg(any(feature = "52833", feature = "52840"))]
@@ -60,10 +63,13 @@ pub struct Pin<MODE> {
 #[cfg(feature = "51")]
 use crate::pac::{gpio, GPIO as P0};
 
-#[cfg(feature = "9160")]
+#[cfg(any(feature = "5340-app", feature = "9160"))]
 use crate::pac::{p0_ns as gpio, P0_NS as P0};
 
-#[cfg(not(any(feature = "9160", feature = "51")))]
+#[cfg(feature = "5340-app")]
+use crate::pac::P0_S;
+
+#[cfg(not(any(feature = "9160", feature = "5340-app", feature = "51")))]
 use crate::pac::{p0 as gpio, P0};
 
 #[cfg(any(feature = "52833", feature = "52840"))]
@@ -76,6 +82,8 @@ impl<MODE> Pin<MODE> {
     fn new(port: Port, pin: u8) -> Self {
         let port_bits = match port {
             Port::Port0 => 0x00,
+            #[cfg(any(feature = "5340-app"))]
+            Port::Port0Secure => 0x20,
             #[cfg(any(feature = "52833", feature = "52840"))]
             Port::Port1 => 0x20,
         };
@@ -94,12 +102,12 @@ impl<MODE> Pin<MODE> {
 
     #[inline]
     pub fn pin(&self) -> u8 {
-        #[cfg(any(feature = "52833", feature = "52840"))]
+        #[cfg(any(feature = "52833", feature = "52840", feature = "5340-app"))]
         {
             self.pin_port & 0x1f
         }
 
-        #[cfg(not(any(feature = "52833", feature = "52840")))]
+        #[cfg(not(any(feature = "52833", feature = "52840", feature = "5340-app")))]
         {
             self.pin_port
         }
@@ -116,7 +124,16 @@ impl<MODE> Pin<MODE> {
             }
         }
 
-        #[cfg(not(any(feature = "52833", feature = "52840")))]
+        #[cfg(any(feature = "5340-app"))]
+        {
+            if self.pin_port & 0x20 == 0 {
+                Port::Port0
+            } else {
+                Port::Port0Secure
+            }
+        }
+
+        #[cfg(not(any(feature = "52833", feature = "52840", feature = "5340-app")))]
         {
             Port::Port0
         }
@@ -130,6 +147,8 @@ impl<MODE> Pin<MODE> {
     fn block(&self) -> &gpio::RegisterBlock {
         let ptr = match self.port() {
             Port::Port0 => P0::ptr(),
+            #[cfg(any(feature = "5340-app"))]
+            Port::Port0Secure => P0_S::ptr(),
             #[cfg(any(feature = "52833", feature = "52840"))]
             Port::Port1 => P1::ptr(),
         };
@@ -320,10 +339,10 @@ pub enum OpenDrainConfig {
 #[cfg(feature = "51")]
 use crate::pac::gpio::pin_cnf;
 
-#[cfg(feature = "9160")]
+#[cfg(any(feature = "5340-app", feature = "9160"))]
 use crate::pac::p0_ns::pin_cnf;
 
-#[cfg(not(any(feature = "9160", feature = "51")))]
+#[cfg(not(any(feature = "9160", feature = "5340-app", feature = "51")))]
 use crate::pac::p0::pin_cnf;
 
 impl OpenDrainConfig {
@@ -647,3 +666,39 @@ gpio!(P1, p0, p1, Port::Port1, [
     P1_14: (p1_14, 14, Disconnected),
     P1_15: (p1_15, 15, Disconnected),
 ]);
+
+#[cfg(any(feature = "5340-app"))]
+gpio!(P0_S, p0, p0_s, Port::Port0Secure, [
+    P0_00: (p0_00,  0, Disconnected),
+    P0_01: (p0_01,  1, Disconnected),
+    P0_02: (p0_02,  2, Disconnected),
+    P0_03: (p0_03,  3, Disconnected),
+    P0_04: (p0_04,  4, Disconnected),
+    P0_05: (p0_05,  5, Disconnected),
+    P0_06: (p0_06,  6, Disconnected),
+    P0_07: (p0_07,  7, Disconnected),
+    P0_08: (p0_08,  8, Disconnected),
+    P0_09: (p0_09,  9, Disconnected),
+    P0_10: (p0_10, 10, Disconnected),
+    P0_11: (p0_11, 11, Disconnected),
+    P0_12: (p0_12, 12, Disconnected),
+    P0_13: (p0_13, 13, Disconnected),
+    P0_14: (p0_14, 14, Disconnected),
+    P0_15: (p0_15, 15, Disconnected),
+    P0_16: (p0_16, 16, Disconnected),
+    P0_17: (p0_17, 17, Disconnected),
+    P0_18: (p0_18, 18, Disconnected),
+    P0_19: (p0_19, 19, Disconnected),
+    P0_20: (p0_20, 20, Disconnected),
+    P0_21: (p0_21, 21, Disconnected),
+    P0_22: (p0_22, 22, Disconnected),
+    P0_23: (p0_23, 23, Disconnected),
+    P0_24: (p0_24, 24, Disconnected),
+    P0_25: (p0_25, 25, Disconnected),
+    P0_26: (p0_26, 26, Disconnected),
+    P0_27: (p0_27, 27, Disconnected),
+    P0_28: (p0_28, 28, Disconnected),
+    P0_29: (p0_29, 29, Disconnected),
+    P0_30: (p0_30, 30, Disconnected),
+    P0_31: (p0_31, 31, Disconnected),
+]);

nrf-hal-common/src/i2s.rs

@@ -1,8 +1,10 @@
 //! HAL interface for the I2S peripheral.
 //!
 
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "5340-app", feature = "9160")))]
 use crate::pac::{i2s, I2S as I2S_PAC};
+#[cfg(feature = "5340-app")]
+use crate::pac::{i2s0_ns as i2s, I2S0_NS as I2S_PAC};
 #[cfg(feature = "9160")]
 use crate::pac::{i2s_ns as i2s, I2S_NS as I2S_PAC};
 use crate::{
@@ -198,7 +200,12 @@ impl I2S {
         self.i2s
             .config
             .swidth
-            .write(|w| unsafe { w.swidth().bits(width.into()) });
+            .write(|w| {
+                   #[cfg(not(feature = "5340-app"))]
+                   unsafe { w.swidth().bits(width.into()) }
+                   #[cfg(feature = "5340-app")]
+                   w.swidth().bits(width.into())
+            });
         self
     }
 

nrf-hal-common/src/lib.rs

@@ -24,49 +24,57 @@ pub use nrf52833_pac as pac;
 #[cfg(feature = "52840")]
 pub use nrf52840_pac as pac;
 
+#[cfg(feature = "5340-app")]
+pub use nrf5340_app_pac as pac;
+
 #[cfg(feature = "9160")]
 pub use nrf9160_pac as pac;
 
 #[cfg(feature = "51")]
 pub mod adc;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod ccm;
 pub mod clocks;
-#[cfg(not(any(feature = "51", feature = "9160")))]
+#[cfg(not(any(feature = "51", feature = "9160", feature = "5340-app")))]
 pub mod comp;
 #[cfg(not(feature = "51"))]
 pub mod delay;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod ecb;
 pub mod gpio;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod gpiote;
 #[cfg(not(any(feature = "51", feature = "52810", feature = "52811")))]
 pub mod i2s;
 #[cfg(any(feature = "52833", feature = "52840"))]
 pub mod ieee802154;
-#[cfg(not(any(feature = "52811", feature = "52810", feature = "9160")))]
+#[cfg(not(any(
+    feature = "52811",
+    feature = "52810",
+    feature = "9160",
+    feature = "5340-app"
+)))]
 pub mod lpcomp;
 #[cfg(not(feature = "51"))]
 pub mod nvmc;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod ppi;
 #[cfg(not(feature = "51"))]
 pub mod pwm;
-#[cfg(not(any(feature = "51", feature = "9160")))]
+#[cfg(not(any(feature = "51", feature = "9160", feature = "5340-app")))]
 pub mod qdec;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod rng;
 pub mod rtc;
 #[cfg(not(feature = "51"))]
 pub mod saadc;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod spi;
 #[cfg(not(feature = "51"))]
 pub mod spim;
 #[cfg(not(feature = "51"))]
 pub mod spis;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod temp;
 pub mod time;
 pub mod timer;
@@ -80,7 +88,7 @@ pub mod twis;
 pub mod uart;
 #[cfg(not(feature = "51"))]
 pub mod uarte;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub mod uicr;
 #[cfg(feature = "nrf-usbd")]
 pub mod usbd;
@@ -90,7 +98,7 @@ pub mod prelude {
     pub use crate::hal::digital::v2::*;
     pub use crate::hal::prelude::*;
 
-    #[cfg(not(feature = "9160"))]
+    #[cfg(not(any(feature = "9160", feature = "5340-app")))]
     pub use crate::ppi::{ConfigurablePpi, Ppi};
     pub use crate::time::U32Ext;
 }
@@ -113,7 +121,7 @@ pub mod target_constants {
     pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
     #[cfg(feature = "52840")]
     pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
-    #[cfg(feature = "5340")]
+    #[cfg(feature = "5340-app")]
     pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
     #[cfg(feature = "9160")]
     pub const EASY_DMA_SIZE: usize = (1 << 12) - 1;
@@ -172,7 +180,7 @@ impl DmaSlice {
 pub use crate::clocks::Clocks;
 #[cfg(not(feature = "51"))]
 pub use crate::delay::Delay;
-#[cfg(not(feature = "9160"))]
+#[cfg(not(any(feature = "9160", feature = "5340-app")))]
 pub use crate::rng::Rng;
 pub use crate::rtc::Rtc;
 pub use crate::timer::Timer;