83 lines
2.6 KiB
Rust
83 lines
2.6 KiB
Rust
//! # API for the GPIO peripheral
|
|
//!
|
|
//! The implementation of this GPIO module is heavily based on the
|
|
//! [ATSAMD HAL implementation](https://docs.rs/atsamd-hal/latest/atsamd_hal/gpio/index.html).
|
|
//!
|
|
//! This API provides two different submodules, [`mod@pins`] and [`dynpins`],
|
|
//! representing two different ways to handle GPIO pins. The default, [`mod@pins`],
|
|
//! is a type-level API that tracks the state of each pin at compile-time. The
|
|
//! alternative, [`dynpins`] is a type-erased, value-level API that tracks the
|
|
//! state of each pin at run-time.
|
|
//!
|
|
//! The type-level API is strongly preferred. By representing the state of each
|
|
//! pin within the type system, the compiler can detect logic errors at
|
|
//! compile-time. Furthermore, the type-level API has absolutely zero run-time
|
|
//! cost.
|
|
//!
|
|
//! If needed, [`dynpins`] can be used to erase the type-level differences
|
|
//! between pins. However, by doing so, pins must now be tracked at run-time,
|
|
//! and each pin has a non-zero memory footprint.
|
|
//!
|
|
//! ## Examples
|
|
//!
|
|
//! - [Blinky example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/blinky.rs)
|
|
|
|
#[derive(Debug, PartialEq, Eq)]
|
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
pub struct IsMaskedError(pub(crate) ());
|
|
|
|
macro_rules! common_reg_if_functions {
|
|
() => {
|
|
paste::paste!(
|
|
#[inline]
|
|
pub fn datamask(&self) -> bool {
|
|
self.regs.datamask()
|
|
}
|
|
|
|
#[inline]
|
|
pub fn clear_datamask(self) -> Self {
|
|
self.regs.clear_datamask();
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_datamask(self) -> Self {
|
|
self.regs.set_datamask();
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
pub fn is_high_masked(&self) -> Result<bool, crate::gpio::IsMaskedError> {
|
|
self.regs.read_pin_masked()
|
|
}
|
|
|
|
#[inline]
|
|
pub fn is_low_masked(&self) -> Result<bool, crate::gpio::IsMaskedError> {
|
|
self.regs.read_pin_masked().map(|v| !v)
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_high_masked(&mut self) -> Result<(), crate::gpio::IsMaskedError> {
|
|
self.regs.write_pin_masked(true)
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_low_masked(&mut self) -> Result<(), crate::gpio::IsMaskedError> {
|
|
self.regs.write_pin_masked(false)
|
|
}
|
|
|
|
fn irq_enb(&mut self) {
|
|
self.regs.enable_irq();
|
|
}
|
|
);
|
|
};
|
|
}
|
|
|
|
pub mod pin;
|
|
pub use pin::*;
|
|
|
|
pub mod dynpin;
|
|
pub use dynpin::*;
|
|
|
|
mod reg;
|