caravel-hal 1.0.3

Hardware Abstraction Layer Crate for the Caravel management SoC.
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

use embedded_hal::digital::{ErrorType, InputPin, OutputPin, StatefulOutputPin};

use caravel_pac::GpioRegisters;

/// Driver for the Caravel management GPIO pin
pub struct Gpio {
    regs: &'static GpioRegisters,
}

unsafe impl Send for Gpio {}

impl Gpio {
    #[allow(clippy::new_without_default)]
    pub const fn new() -> Self {
        Self {
            regs: GpioRegisters::new(),
        }
    }

    /// Enable or disable the output driver
    #[inline]
    pub fn set_output_enable(&mut self, enable: bool) {
        unsafe {
            let input_enabled = self.regs.ien.read() != 0;

            self.regs.mode1.write(enable as u32);

            // mode0 (DM[0]) must be 1 for input enable if output disabled
            self.regs.mode0.write((!enable && input_enabled) as u32);

            self.regs.oe.write(enable as u32);
        }
    }

    /// Enable or disable the input buffer
    #[inline]
    pub fn set_input_enable(&mut self, enable: bool) {
        unsafe {
            // mode0 (DM[0]) must be 1 for input enable if output disabled
            let output_enabled = self.regs.oe.read() != 0;
            self.regs.mode0.write((enable && !output_enabled) as u32);

            self.regs.ien.write(enable as u32);
        }
    }
}

impl ErrorType for Gpio {
    type Error = core::convert::Infallible;
}

impl OutputPin for Gpio {
    #[inline]
    fn set_low(&mut self) -> Result<(), Self::Error> {
        unsafe {
            self.regs.output.write(0);
        }
        Ok(())
    }

    #[inline]
    fn set_high(&mut self) -> Result<(), Self::Error> {
        unsafe {
            self.regs.output.write(1);
        }
        Ok(())
    }
}

impl StatefulOutputPin for Gpio {
    #[inline]
    fn is_set_high(&mut self) -> Result<bool, Self::Error> {
        Ok(self.regs.output.read() != 0)
    }

    #[inline]
    fn is_set_low(&mut self) -> Result<bool, Self::Error> {
        Ok(self.regs.output.read() == 0)
    }
}

impl InputPin for Gpio {
    #[inline]
    fn is_high(&mut self) -> Result<bool, Self::Error> {
        Ok(self.regs.input.read() != 0)
    }

    #[inline]
    fn is_low(&mut self) -> Result<bool, Self::Error> {
        Ok(self.regs.input.read() == 0)
    }
}