aboutsummaryrefslogtreecommitdiff
path: root/src/checked.rs
blob: 87318eca7f7b7082ef701bba9698115c38ae2933 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
//! Safe, run-time checked resources

use core::marker::PhantomData;
use core::cell::UnsafeCell;

use cortex_m::interrupt;
use cortex_m::register::{basepri, basepri_max};
use vcell::VolatileCell;

use Ceiling;

unsafe fn acquire(locked: &VolatileCell<bool>, ceiling: u8) -> u8 {
    interrupt::free(
        |_| {
            assert!(!locked.get(), "resource already locked");
            let old_basepri = basepri::read();
            basepri_max::write(ceiling);
            locked.set(true);
            old_basepri
        },
    )
}

unsafe fn release(locked: &VolatileCell<bool>, old_basepri: u8) {
    // XXX Is it really memory safe to *not* use a global critical section here
    // interrupt::free(
        // |_| {
            locked.set(false);
            basepri::write(old_basepri);
        // },
    // );
}

/// A totally safe `Resource` that panics on misuse
pub struct Resource<T, C> {
    _marker: PhantomData<C>,
    data: UnsafeCell<T>,
    locked: VolatileCell<bool>,
}

impl<T, C> Resource<T, C>
where
    C: Ceiling,
{
    /// Creates a new `Resource` with ceiling `C`
    pub const fn new(data: T) -> Resource<T, C> {
        Resource {
            _marker: PhantomData,
            data: UnsafeCell::new(data),
            locked: VolatileCell::new(false),
        }
    }

    /// Locks the resource, blocking tasks with priority equal or smaller than
    /// the ceiling `C`
    pub fn lock<R, F>(&'static self, f: F) -> R
    where
        F: FnOnce(&T) -> R,
    {
        unsafe {
            let old_basepri = acquire(&self.locked, C::hw_ceiling());
            ::compiler_barrier();
            let ret = f(&*self.data.get());
            ::compiler_barrier();
            release(&self.locked, old_basepri);
            ret
        }
    }

    /// Mutably locks the resource, blocking tasks with priority equal or
    /// smaller than the ceiling `C`
    pub fn lock_mut<R, F>(&'static self, f: F) -> R
        where
        F: FnOnce(&mut T) -> R,
    {
        unsafe {
            let old_basepri = acquire(&self.locked, C::hw_ceiling());
            ::compiler_barrier();
            let ret = f(&mut *self.data.get());
            ::compiler_barrier();
            release(&self.locked, old_basepri);
            ret
        }
    }
}

unsafe impl<T, C> Sync for Resource<T, C> {}