Open Drain Output

avr-hal-generic/src/port.rs

@@ -3,7 +3,7 @@
 //! Please take a look at the documentation for [`Pin`] for a detailed explanation.
 
 use core::marker::PhantomData;
-use embedded_hal::digital::v2::{OutputPin, InputPin};
+use embedded_hal::digital::v2::{InputPin, OutputPin};
 
 pub trait PinMode: crate::Sealed {}
 /// GPIO pin modes
@@ -18,6 +18,12 @@ pub mod mode {
     impl Io for Output {}
     impl crate::Sealed for Output {}
 
+    // Pin is configures as a digital output with open drain behaviour
+    pub struct OpenDrain;
+    impl super::PinMode for OpenDrain {}
+    impl Io for OpenDrain {}
+    impl crate::Sealed for OpenDrain {}
+
     pub trait InputMode: crate::Sealed {}
 
     /// Pin is configured as digital input (floating or pulled-up).
@@ -137,6 +143,28 @@ impl<PIN: PinOps, MODE: mode::Io> Pin<MODE, PIN> {
         }
     }
 
+    /// Convert this pin into an output pin with open drain, setting the state to low
+    /// See [Digital Output Open Drain](#digital-output-open-drain)
+    pub fn into_opendrain(mut self) -> Pin<mode::OpenDrain, PIN> {
+        unsafe { self.pin.out_clear() };
+        unsafe { self.pin.make_output() };
+        Pin {
+            pin: self.pin,
+            _mode: PhantomData,
+        }
+    }
+
+    /// Convert this pin into an output pin with open drain, setting the state to tristate
+    /// See [Digital Output Open Drain](#digital-output-open-drain)
+    pub fn into_opendrain_tristate(mut self) -> Pin<mode::OpenDrain, PIN> {
+        unsafe { self.pin.out_clear() };
+        unsafe { self.pin.make_input(false) };
+        Pin {
+            pin: self.pin,
+            _mode: PhantomData,
+        }
+    }
+
     /// Convert this pin into a floating input pin.  See [Digital Input](#digital-input).
     ///
     /// *Note*: To read deterministic values from the pin, it must be externally pulled to a
@@ -300,6 +328,65 @@ impl<PIN: PinOps> OutputPin for Pin<mode::Output, PIN> {
     }
 }
 
+/// # Digital Output Open Drain
+impl<PIN: PinOps> Pin<mode::OpenDrain, PIN> {
+    /// Set the pin to tristate mode (Input without PullUp)
+    #[inline]
+    pub fn set_tristate(&mut self) {
+        unsafe { self.pin.make_input(false) }
+    }
+
+    /// Set pin low (pull it to GND, Output to low).
+    #[inline]
+    pub fn set_low(&mut self) {
+        unsafe { self.pin.make_output() }
+    }
+
+    /// Check whether the pin is set high.
+    ///
+    /// *Note*: The electrical state of the pin might differ due to external circuitry.
+    #[inline]
+    pub fn is_set_high(&self) -> bool {
+        unsafe { self.pin.in_get() }
+    }
+
+    /// Check whether the pin is set low.
+    ///
+    /// *Note*: The electrical state of the pin might differ due to external circuitry.
+    #[inline]
+    pub fn is_set_low(&self) -> bool {
+        !unsafe { self.pin.in_get() }
+    }
+}
+
+// Implements OutputPin from embedded-hal to make sure external libraries work
+impl<PIN: PinOps> OutputPin for Pin<mode::OpenDrain, PIN> {
+    type Error = core::convert::Infallible;
+
+    fn set_high(&mut self) -> Result<(), Self::Error> {
+        self.set_tristate();
+        Ok(())
+    }
+
+    fn set_low(&mut self) -> Result<(), Self::Error> {
+        self.set_low();
+        Ok(())
+    }
+}
+
+// Implements InputPin from embedded-hal to make sure external libraries work
+impl<PIN: PinOps> InputPin for Pin<mode::OpenDrain, PIN> {
+    type Error = core::convert::Infallible;
+
+    fn is_high(&self) -> Result<bool, Self::Error> {
+        Ok(self.is_set_high())
+    }
+
+    fn is_low(&self) -> Result<bool, Self::Error> {
+        Ok(self.is_set_low())
+    }
+}
+
 // Implements InputPin from embedded-hal to make sure external libraries work
 impl<PIN: PinOps, IMODE: mode::InputMode> InputPin for Pin<mode::Input<IMODE>, PIN> {
     type Error = core::convert::Infallible;