xous 0.9.70

System call interface for Xous
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
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

/// Flags to be passed to the MapMemory struct.
/// Note that it is an error to have memory be
/// writable and not readable.
#[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash, Debug)]
pub struct MemoryFlags {
    bits: usize,
}

impl MemoryFlags {
    /// Marks the page as the 'device' page for on-chip peripherals.
    pub const DEV: Self = Self { bits: 0b0001_0000 };
    const FLAGS_ALL: usize = 0b11_1111;
    /// Free this memory
    pub const FREE: Self = Self { bits: 0b0000_0000 };
    /// Page is swapped
    pub const P: Self = Self { bits: 0b10_0000_0000 };
    /// Allow the CPU to read from this page.
    pub const R: Self = Self { bits: 0b0000_0010 };
    /// Immediately allocate this memory.  Otherwise it will
    /// be demand-paged.  This is implicitly set when `phys`
    /// is not 0.
    pub const RESERVE: Self = Self { bits: 0b0000_0001 };
    /// Marks the page as pure virtual; i.e., memory mapped SPI FLASH
    pub const VIRT: Self = Self { bits: 0b0010_0000 };
    /// Allow the CPU to write to this page.
    pub const W: Self = Self { bits: 0b0000_0100 };
    /// Allow the CPU to execute from this page.
    pub const X: Self = Self { bits: 0b0000_1000 };

    pub fn bits(&self) -> usize { self.bits }

    pub fn from_bits(raw: usize) -> Option<MemoryFlags> {
        if raw > Self::FLAGS_ALL { None } else { Some(MemoryFlags { bits: raw }) }
    }

    pub fn is_empty(&self) -> bool { self.bits == 0 }

    pub fn empty() -> MemoryFlags { MemoryFlags { bits: 0 } }

    pub fn all() -> MemoryFlags { MemoryFlags { bits: Self::FLAGS_ALL } }
}

// impl core::fmt::Debug for MemoryFlags {
//     fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
//         // Iterate over the valid flags
//         let mut first = true;
//         for (name, _) in self.iter() {
//             if !first {
//                 f.write_str(" | ")?;
//             }

//             first = false;
//             f.write_str(name)?;
//         }

//         // Append any extra bits that correspond to flags to the end of the format
//         let extra_bits = self.bits & !Self::all().bits();

//         // if extra_bits != <$T as Bits>::EMPTY {
//         //     if !first {
//         //         f.write_str(" | ")?;
//         //     }
//         //     first = false;
//         //     core::write!(f, "{:#x}", extra_bits)?;
//         // }

//         if first {
//             f.write_str("(empty)")?;
//         }

//         core::fmt::Result::Ok(())
//     }
// }

impl core::fmt::Binary for MemoryFlags {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result { core::fmt::Binary::fmt(&self.bits, f) }
}

impl core::fmt::Octal for MemoryFlags {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result { core::fmt::Octal::fmt(&self.bits, f) }
}

impl core::fmt::LowerHex for MemoryFlags {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        core::fmt::LowerHex::fmt(&self.bits, f)
    }
}

impl core::fmt::UpperHex for MemoryFlags {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        core::fmt::UpperHex::fmt(&self.bits, f)
    }
}

impl core::ops::BitOr for MemoryFlags {
    type Output = Self;

    /// Returns the union of the two sets of flags.
    #[inline]
    fn bitor(self, other: MemoryFlags) -> Self { Self { bits: self.bits | other.bits } }
}

impl core::ops::BitOrAssign for MemoryFlags {
    /// Adds the set of flags.
    #[inline]
    fn bitor_assign(&mut self, other: Self) { self.bits |= other.bits; }
}

impl core::ops::BitXor for MemoryFlags {
    type Output = Self;

    /// Returns the left flags, but with all the right flags toggled.
    #[inline]
    fn bitxor(self, other: Self) -> Self { Self { bits: self.bits ^ other.bits } }
}

impl core::ops::BitXorAssign for MemoryFlags {
    /// Toggles the set of flags.
    #[inline]
    fn bitxor_assign(&mut self, other: Self) { self.bits ^= other.bits; }
}

impl core::ops::BitAnd for MemoryFlags {
    type Output = Self;

    /// Returns the intersection between the two sets of flags.
    #[inline]
    fn bitand(self, other: Self) -> Self { Self { bits: self.bits & other.bits } }
}

impl core::ops::BitAndAssign for MemoryFlags {
    /// Disables all flags disabled in the set.
    #[inline]
    fn bitand_assign(&mut self, other: Self) { self.bits &= other.bits; }
}

impl core::ops::Sub for MemoryFlags {
    type Output = Self;

    /// Returns the set difference of the two sets of flags.
    #[inline]
    fn sub(self, other: Self) -> Self { Self { bits: self.bits & !other.bits } }
}

impl core::ops::SubAssign for MemoryFlags {
    /// Disables all flags enabled in the set.
    #[inline]
    fn sub_assign(&mut self, other: Self) { self.bits &= !other.bits; }
}

impl core::ops::Not for MemoryFlags {
    type Output = Self;

    /// Returns the complement of this set of flags.
    #[inline]
    fn not(self) -> Self { Self { bits: !self.bits } & MemoryFlags { bits: 15 } }
}