percore 0.2.5

Safe per-CPU core mutable state on no_std platforms through exception masking.
Documentation 
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

// Copyright 2024 The percore Authors.
// This project is dual-licensed under Apache 2.0 and MIT terms.
// See LICENSE-APACHE and LICENSE-MIT for details.

use core::arch::asm;

/// Exception mask value which has been saved to later be restored.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(transparent)]
pub struct ExceptionMask(u32);

/// Mask for the SError interrupt mask, IRQ mask and FIQ mask bits of CPSR.
const AIF_MASK: u32 = 0x7 << 6;

impl ExceptionMask {
    /// Masks IRQs, FIQs, SErrors and Debug exceptions.
    ///
    /// Returns the previous mask value, to be passed to [`unmask`].
    pub fn mask() -> Self {
        let prev: u32;

        // SAFETY: Writing to this system register doesn't access memory in any way.
        unsafe {
            asm!(
                "mrs {prev}, CPSR",
                "cpsid aif",
                options(nostack),
                prev = out(reg) prev,
            );
        }

        Self(prev & AIF_MASK)
    }

    /// Restores the given previous exception mask value.
    ///
    /// # Safety
    ///
    /// Must not be called while a corresponding `ExceptionFree` token exists.
    pub unsafe fn restore(self) {
        let mask = self.0 | !AIF_MASK;

        // SAFETY: Writing to this system register doesn't access memory in any way. The caller promised
        // that there is no `ExceptionFree` token.
        unsafe {
            asm!(
                "mrs {temp}, CPSR",
                "and {temp}, {temp}, {mask}",
                "msr CPSR, {temp}",
                options(nostack),
                temp = out(reg) _,
                mask = in(reg) mask,
            );
        }
    }
}