avr_tester/pins/

digital_pin.rs

use crate::*;

/// Provides access to a digital pin, e.g. `PD4`.
pub struct DigitalPin<'a> {
    avr: &'a mut AvrTester,
    port: char,
    pin: u8,
}

impl<'a> DigitalPin<'a> {
    pub(crate) fn new(avr: &'a mut AvrTester, port: char, pin: u8) -> Self {
        Self { avr, port, pin }
    }

    /// Changes pin's state to low or high.
    pub fn set(&mut self, high: bool) {
        self.avr.sim().set_digital_pin(self.port, self.pin, high);
    }

    /// Changes pin's state to low.
    pub fn set_low(&mut self) {
        self.set(false);
    }

    /// Changes pin's state to high.
    pub fn set_high(&mut self) {
        self.set(true);
    }

    /// Changes pin's state from low to high or from high to low.
    pub fn toggle(&mut self) {
        if self.is_low() {
            self.set_high();
        } else {
            self.set_low();
        }
    }

    /// Returns whether pin's state is low.
    pub fn is_low(&mut self) -> bool {
        !self.is_high()
    }

    /// Returns whether pin's state is high.
    pub fn is_high(&mut self) -> bool {
        self.avr.sim().get_digital_pin(self.port, self.pin)
    }

    /// Asserts that pin's state is high or low.
    #[track_caller]
    pub fn assert(&mut self, high: bool) {
        if high {
            self.assert_high();
        } else {
            self.assert_low();
        }
    }

    /// Asserts that pin's state is low.
    #[track_caller]
    pub fn assert_low(&mut self) {
        assert!(self.is_low(), "{} is not low", self.name());
    }

    /// Asserts that pin's state is high.
    #[track_caller]
    pub fn assert_high(&mut self) {
        assert!(self.is_high(), "{} is not high", self.name());
    }

    /// Waits until pin switches state (e.g. from low to high or from high to
    /// low).
    ///
    /// Returns duration it took for the pin to switch state.
    pub fn pulse_in(&mut self) -> AvrDuration {
        let mut tt = AvrDuration::zero(self.avr);
        let state = self.is_high();

        while self.is_high() == state {
            tt += self.avr.run();
        }

        tt
    }

    /// Waits until pin becomes high; if the pin is already high, exits
    /// immediately.
    ///
    /// Returns duration it took for the pin to get high.
    pub fn wait_while_low(&mut self) -> AvrDuration {
        let mut tt = AvrDuration::zero(self.avr);

        while self.is_low() {
            tt += self.avr.run();
        }

        tt
    }

    /// Waits until pin becomes high or timeout is reached; if the pin is
    /// already high, exits immediately.
    ///
    /// Returns a result containing the amount of time that has passed
    /// for the device.
    ///
    /// If the timeout was reached before the pin state changed, the
    /// duration will be contained in the `Err` variant, otherwise
    /// the `Ok` variant contains the duration it took for the pin to
    /// get high.
    pub fn wait_while_low_timeout(
        &mut self,
        timeout: AvrDuration,
    ) -> Result<AvrDuration, AvrDuration> {
        let mut tt = AvrDuration::zero(self.avr);

        while self.is_low() {
            if tt >= timeout {
                return Err(tt);
            }
            tt += self.avr.run();
        }

        Ok(tt)
    }

    /// Waits until pin becomes low; if the pin is already low, exits
    /// immediately.
    ///
    /// Returns duration it took for the pin to get low.
    pub fn wait_while_high(&mut self) -> AvrDuration {
        let mut tt = AvrDuration::zero(self.avr);

        while self.is_high() {
            tt += self.avr.run();
        }

        tt
    }

    /// Waits until pin becomes low or timeout is reached; if the pin is
    /// already low, exits immediately.
    ///
    /// Returns a result containing the amount of time that has passed
    /// for the device.
    ///
    /// If the timeout was reached before the pin state changed, the
    /// duration will be contained in the `Err` variant, otherwise
    /// the `Ok` variant contains the duration it took for the pin to
    /// get low.
    pub fn wait_while_high_timeout(
        &mut self,
        timeout: AvrDuration,
    ) -> Result<AvrDuration, AvrDuration> {
        let mut tt = AvrDuration::zero(self.avr);

        while self.is_high() {
            if tt >= timeout {
                return Err(tt);
            }
            tt += self.avr.run();
        }

        Ok(tt)
    }

    /// Return pin's name, e.g. `PC6`.
    pub fn name(&self) -> String {
        format!("P{}{}", self.port, self.pin)
    }
}

/// Asynchronous equivalent of [`DigitalPin`].
///
/// See [`avr_rt()`] for more details.
pub struct DigitalPinAsync {
    port: char,
    pin: u8,
}

impl DigitalPinAsync {
    pub(crate) fn new(port: char, pin: u8) -> Self {
        Self { port, pin }
    }

    /// Asynchronous equivalent of [`DigitalPin::set()`].
    pub fn set(&self, high: bool) {
        ComponentRuntime::with(|rt| {
            rt.sim().set_digital_pin(self.port, self.pin, high);
        })
    }

    /// Asynchronous equivalent of [`DigitalPin::set_low()`].
    pub fn set_low(&self) {
        self.set(false);
    }

    /// Asynchronous equivalent of [`DigitalPin::set_high()`].
    pub fn set_high(&self) {
        self.set(true);
    }

    /// Asynchronous equivalent of [`DigitalPin::toggle()`].
    pub fn toggle(&self) {
        if self.is_low() {
            self.set_high();
        } else {
            self.set_low();
        }
    }

    /// Asynchronous equivalent of [`DigitalPin::is_low()`].
    pub fn is_low(&self) -> bool {
        !self.is_high()
    }

    /// Asynchronous equivalent of [`DigitalPin::is_high()`].
    pub fn is_high(&self) -> bool {
        ComponentRuntime::with(|rt| {
            rt.sim().get_digital_pin(self.port, self.pin)
        })
    }

    /// Asynchronous equivalent of [`DigitalPin::assert_low()`].
    #[track_caller]
    pub fn assert_low(&self) {
        assert!(self.is_low(), "{} is not low", self.name());
    }

    /// Asynchronous equivalent of [`DigitalPin::assert_high()`].
    #[track_caller]
    pub fn assert_high(&self) {
        assert!(self.is_high(), "{} is not high", self.name());
    }

    /// Asynchronous equivalent of [`DigitalPin::pulse_in()`].
    pub async fn pulse_in(&self) -> AvrDuration {
        let mut tt = ComponentRuntime::with(|rt| {
            AvrDuration::new(rt.clock_frequency(), 0)
        });
        let state = self.is_high();

        while self.is_high() == state {
            tt += avr_rt().run().await;
        }

        tt
    }

    /// Asynchronous equivalent of [`DigitalPin::wait_while_low()`].
    pub async fn wait_while_low(&self) -> AvrDuration {
        let mut tt = ComponentRuntime::with(|rt| {
            AvrDuration::new(rt.clock_frequency(), 0)
        });

        while self.is_low() {
            tt += avr_rt().run().await;
        }

        tt
    }

    /// Asynchronous equivalent of [`DigitalPin::wait_while_high()`].
    pub async fn wait_while_high(&self) -> AvrDuration {
        let mut tt = ComponentRuntime::with(|rt| {
            AvrDuration::new(rt.clock_frequency(), 0)
        });

        while self.is_high() {
            tt += avr_rt().run().await;
        }

        tt
    }

    /// Asynchronous equivalent of [`DigitalPin::name()`].
    pub fn name(&self) -> String {
        format!("P{}{}", self.port, self.pin)
    }
}