Exclusive examples

Cargo.toml

@@ -58,6 +58,7 @@ version = '0.5.3'
 name = 'rtic'
 
 # path = "../rtic-core"
+
 [patch.crates-io.rtic-core]
 git = 'https://github.com/rtic-rs/rtic-core.git'
 branch = 'immutable_resource_proxies'

examples/lock5.rs

@@ -62,7 +62,7 @@ const APP: () = {
         static mut STATE: u32 = 0;
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();
         *c.resources.shared += 2;
-        let ex_shared = Exclusive(c.resources.shared);
+        let ex_shared = Exclusive::new(c.resources.shared);
         advance(STATE, ex_shared); // try swap order of (1)
         *c.resources.shared += 3; // and (2), will fail
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();

examples/lock6.rs

@@ -62,11 +62,11 @@ const APP: () = {
         static mut STATE: u32 = 0;
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();
         *c.resources.shared += 2;
-        let mut ex_shared = Exclusive(c.resources.shared);
+        let mut ex_shared = Exclusive::new(c.resources.shared);
         // a mutable exclusive is still possible to DerefMut
         *ex_shared += 1;
+        *c.resources.shared += 3; // will fail
         advance(STATE, ex_shared); // try swap order of (1)
-        *c.resources.shared += 3; // and (2), will fail
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();
     }
 };

examples/lock7.rs

@@ -62,7 +62,7 @@ const APP: () = {
         static mut STATE: u32 = 0;
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();
         *c.resources.shared += 2;
-        advance(STATE, *c.resources.shared); // try swap order of (1)
+        advance(STATE, Exclusive::new(c.resources.shared)); // try swap order of (1)
         *c.resources.shared += 3; // and (2), will fail
         hprintln!("GPIOC(STATE = {})", *STATE).unwrap();
     }

examples/lock8.rs

@@ -0,0 +1,69 @@
+//! examples/lock.rs
+
+#![deny(unsafe_code)]
+#![deny(warnings)]
+#![no_main]
+#![no_std]
+
+use cortex_m_semihosting::{debug, hprintln};
+use lm3s6965::Interrupt;
+use panic_semihosting as _;
+use rtic::Exclusive;
+
+#[rtic::app(device = lm3s6965)]
+const APP: () = {
+    struct Resources {
+        #[init(0)]
+        shared: u32,
+    }
+
+    #[init]
+    fn init(_: init::Context) {
+        rtic::pend(Interrupt::GPIOA);
+    }
+
+    // when omitted priority is assumed to be `1`
+    #[task(binds = GPIOA, resources = [shared])]
+    fn gpioa(c: gpioa::Context) {
+        hprintln!("A").unwrap();
+
+        // the lower priority task requires a critical section to access the data
+        c.resources.shared.lock(|shared| {
+            // data can only be modified within this critical section (closure)
+            *shared += 1;
+
+            // GPIOB will *not* run right now due to the critical section
+            rtic::pend(Interrupt::GPIOB);
+
+            hprintln!("B - shared = {}", *shared).unwrap();
+
+            // GPIOC does not contend for `shared` so it's allowed to run now
+            rtic::pend(Interrupt::GPIOC);
+        });
+
+        // critical section is over: GPIOB can now start
+
+        hprintln!("E").unwrap();
+
+        debug::exit(debug::EXIT_SUCCESS);
+    }
+
+    #[task(binds = GPIOB, priority = 2, resources = [shared])]
+    fn gpiob(c: gpiob::Context) {
+        c.resources.shared.lock(|shared| {
+            *shared += 1;
+            hprintln!("D - shared = {}", shared).unwrap();
+        });
+    }
+
+    #[task(binds = GPIOC, priority = 3, resources = [shared])]
+    fn gpioc(c: gpioc::Context) {
+        let s = Exclusive::new(c.resources.shared);
+        s.lock(|s1| {
+            s.lock(|s2| {
+                *s1 = 2;
+                *s2 = 3;
+            });
+        });
+    }
+};

examples/lock9.rs

@@ -0,0 +1,70 @@
+//! examples/lock.rs
+
+#![deny(unsafe_code)]
+#![deny(warnings)]
+#![no_main]
+#![no_std]
+
+use cortex_m_semihosting::{debug, hprintln};
+use lm3s6965::Interrupt;
+use panic_semihosting as _;
+use rtic::Exclusive;
+
+#[rtic::app(device = lm3s6965)]
+const APP: () = {
+    struct Resources {
+        #[init(0)]
+        shared: u32,
+    }
+
+    #[init]
+    fn init(_: init::Context) {
+        rtic::pend(Interrupt::GPIOA);
+    }
+
+    // when omitted priority is assumed to be `1`
+    #[task(binds = GPIOA, resources = [shared])]
+    fn gpioa(c: gpioa::Context) {
+        hprintln!("A").unwrap();
+
+        // the lower priority task requires a critical section to access the data
+        c.resources.shared.lock(|shared| {
+            // data can only be modified within this critical section (closure)
+            *shared += 1;
+
+            // GPIOB will *not* run right now due to the critical section
+            rtic::pend(Interrupt::GPIOB);
+
+            hprintln!("B - shared = {}", *shared).unwrap();
+
+            // GPIOC does not contend for `shared` so it's allowed to run now
+            rtic::pend(Interrupt::GPIOC);
+        });
+
+        // critical section is over: GPIOB can now start
+
+        hprintln!("E").unwrap();
+
+        debug::exit(debug::EXIT_SUCCESS);
+    }
+
+    #[task(binds = GPIOB, priority = 2, resources = [shared])]
+    fn gpiob(c: gpiob::Context) {
+        c.resources.shared.lock(|shared| {
+            *shared += 1;
+            hprintln!("D - shared = {}", shared).unwrap();
+        });
+    }
+
+    #[task(binds = GPIOC, priority = 3, resources = [shared])]
+    fn gpioc(c: gpioc::Context) {
+        let se1 = Exclusive::new(c.resources.shared);
+        let se2 = Exclusive::new(c.resources.shared);
+        se1.lock(|s1| {
+            se2.lock(|s2| {
+                *s1 = 2;
+                *s2 = 3;
+            });
+        });
+    }
+};

src/lib.rs

@@ -51,7 +51,7 @@ use cortex_m::{
 #[cfg(all(not(feature = "heterogeneous"), not(feature = "homogeneous")))]
 use cortex_m_rt as _; // vector table
 pub use cortex_m_rtic_macros::app;
-pub use rtic_core::Mutex;
+pub use rtic_core::{Exclusive, Mutex};
 
 #[cfg(armv7m)]
 pub mod cyccnt;