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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
//! General purpose I/O.
//!
//! Create a [`Port`](Port) over a RAL GPIO instance. Then, use the `Port` to
//! allocate GPIO outputs and inputs.
//!
//! Use [`Output`](Output) to drive GPIO outputs. Use [`Input`](Input) to read
//! GPIO pin states, and trigger interrupts when GPIO states change.
//!
//! # Interior mutability
//!
//! Methods on `Output` and `Input` take immutable references, `&self`. The hardware
//! guarantees that these operations can occur without data races. Methods that
//! require multiple operations on a register are implemented on the `Port`, and
//! take the GPIO by reference.
//!
//! # Example
//!
//! ```no_run
//! use imxrt_hal::gpio::Port;
//! use imxrt_ral::gpio::GPIO2;
//!
//! let mut gpio2 = Port::new(unsafe { GPIO2::instance() });
//! let gpio_b0_04 = // Handle to GPIO_B0_04 IOMUXC pin, provided by BSP or higher-level HAL...
//! # unsafe { imxrt_iomuxc::imxrt1060::gpio_b0::GPIO_B0_04::new() };
//!
//! let output = gpio2.output(gpio_b0_04);
//! output.set();
//! output.clear();
//! output.toggle();
//!
//! let input = gpio2.input(output.release());
//! assert!(input.is_set());
//! ```
//! # TODO
//!
//! - Fast GPIOs
use crate::{iomuxc, ral};
/// GPIO ports.
pub struct Port<const N: u8> {
gpio: ral::gpio::Instance<N>,
}
impl<const N: u8> Port<N> {
/// Create a GPIO port that can allocate and convert GPIOs.
pub fn new(gpio: ral::gpio::Instance<N>) -> Self {
Self { gpio }
}
fn register_block(&self) -> &'static ral::gpio::RegisterBlock {
let register_block: &ral::gpio::RegisterBlock = &self.gpio;
// Safety: points to peripheral memory, which is static.
// Gpio implementation guarantees that memory which needs
// mutable access to shared GPIO registers passes through
// the Port type.
let register_block: &'static ral::gpio::RegisterBlock =
unsafe { core::mem::transmute(register_block) };
register_block
}
/// Allocate an output GPIO.
pub fn output<P>(&mut self, mut pin: P) -> Output<P>
where
P: iomuxc::gpio::Pin<N>,
{
iomuxc::gpio::prepare(&mut pin);
Output::new(pin, self.register_block(), P::OFFSET)
}
/// Allocate an input GPIO.
pub fn input<P>(&mut self, mut pin: P) -> Input<P>
where
P: iomuxc::gpio::Pin<N>,
{
iomuxc::gpio::prepare(&mut pin);
Input::new(pin, self.register_block(), P::OFFSET)
}
/// Enable or disable GPIO input interrupts.
///
/// Specify `None` to disable interrupts. Or, provide a trigger
/// to configure the interrupt.
pub fn set_interrupt<P>(&mut self, pin: &Input<P>, trigger: Option<Trigger>) {
self.set_interrupt_enable(pin, false);
if let Some(trigger) = trigger {
self.set_interrupt_trigger(pin, trigger);
self.set_interrupt_enable(pin, true);
}
}
/// Set the GPIO input interrupt trigger for the provided input pin.
fn set_interrupt_trigger<P>(&mut self, pin: &Input<P>, trigger: Trigger) {
if Trigger::EitherEdge == trigger {
ral::modify_reg!(ral::gpio, self.gpio, EDGE_SEL, |edge_sel| {
edge_sel | pin.mask()
});
} else {
ral::modify_reg!(ral::gpio, self.gpio, EDGE_SEL, |edge_sel| {
edge_sel & !pin.mask()
});
let icr = trigger as u32;
let icr_modify = |reg| reg & !(0b11 << pin.icr_offset()) | (icr << pin.icr_offset());
if pin.offset < 16 {
ral::modify_reg!(ral::gpio, self.gpio, ICR1, icr_modify);
} else {
ral::modify_reg!(ral::gpio, self.gpio, ICR2, icr_modify);
}
}
}
/// Enable (`true`) or disable (`false`) interrupt generation.
fn set_interrupt_enable<P>(&mut self, pin: &Input<P>, enable: bool) {
if enable {
ral::modify_reg!(ral::gpio, self.gpio, IMR, |imr| imr | pin.mask());
} else {
ral::modify_reg!(ral::gpio, self.gpio, IMR, |imr| imr & !pin.mask());
}
}
}
/// An output GPIO.
pub struct Output<P> {
pin: P,
// Logical ownership:
// - DR: read only
// - PSR: read only
// - DR_SET, DR_CLEAR, DR_TOGGLE: write 1 to set value in DR
gpio: &'static ral::gpio::RegisterBlock,
offset: u32,
}
// Safety: an output pin is safe to send across execution contexts,
// because it points to static memory.
unsafe impl<P: Send> Send for Output<P> {}
impl<P> Output<P> {
fn new(pin: P, gpio: &'static ral::gpio::RegisterBlock, offset: u32) -> Self {
let output = Self { pin, gpio, offset };
ral::modify_reg!(ral::gpio, gpio, GDIR, |gdir| gdir | output.mask());
output
}
const fn mask(&self) -> u32 {
1 << self.offset
}
/// Set the GPIO high.
pub fn set(&self) {
// Atomic write, OK to take immutable reference.
ral::write_reg!(ral::gpio, self.gpio, DR_SET, self.mask());
}
/// Set the GPIO low.
pub fn clear(&self) {
// Atomic write, OK to take immutable reference.
ral::write_reg!(ral::gpio, self.gpio, DR_CLEAR, self.mask());
}
/// Alternate the GPIO pin output.
///
/// `toggle` is implemented in hardware, so it will be more efficient
/// than implementing in software.
pub fn toggle(&self) {
// Atomic write, OK to take immutable reference.
ral::write_reg!(ral::gpio, self.gpio, DR_TOGGLE, self.mask());
}
/// Returns `true` if the GPIO is set.
pub fn is_set(&self) -> bool {
ral::read_reg!(ral::gpio, self.gpio, DR) & self.mask() != 0
}
/// Returns `true` if the value of the pad is high.
///
/// Can differ from [`is_set()`](Self::is_set), especially in an open drain config.
pub fn is_pad_high(&self) -> bool {
ral::read_reg!(ral::gpio, self.gpio, PSR) & self.mask() != 0
}
/// Release the underlying pin object.
pub fn release(self) -> P {
self.pin
}
/// Access the underlying pin.
pub fn pin(&self) -> &P {
&self.pin
}
/// Mutably access the underling pin.
pub fn pin_mut(&mut self) -> &mut P {
&mut self.pin
}
}
impl Output<()> {
/// Allocate an output GPIO without a pin.
///
/// Prefer using [`Port::output`](Port::output) to create a GPIO ouptut with a
/// pin resource. That method ensures that pin resources are managed throughout
/// your program, and that the pin is configured to operate as a GPIO output.
///
/// You may use this method to allocate duplicate `Output` object for the same
/// physical GPIO output. This is considered safe, since the `Output` API is
/// reentrant.
///
/// If you use this constructor, you're responsible for configuring the IOMUX
/// multiplexer register.
pub fn without_pin<const N: u8>(port: &mut Port<N>, offset: u32) -> Self {
Self::new((), port.register_block(), offset)
}
}
/// An input GPIO.
pub struct Input<P> {
pin: P,
// Logical ownership:
// - PSR: read only
// - ISR: read, W1C
gpio: &'static ral::gpio::RegisterBlock,
offset: u32,
}
// Safety: see impl Send for Output.
unsafe impl<P: Send> Send for Input<P> {}
/// Input interrupt triggers.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u32)]
pub enum Trigger {
/// Interrupt when GPIO is low
Low = 0,
/// Interrupt when GPIO is high
High = 1,
/// Interrupt after GPIO rising edge
RisingEdge = 2,
/// Interrupt after GPIO falling edge
FallingEdge = 3,
/// Interrupt after either a rising or falling edge
EitherEdge = 4,
}
impl<P> Input<P> {
fn new(pin: P, gpio: &'static ral::gpio::RegisterBlock, offset: u32) -> Self {
let input = Self { pin, gpio, offset };
ral::modify_reg!(ral::gpio, gpio, GDIR, |gdir| gdir & !input.mask());
input
}
const fn mask(&self) -> u32 {
1 << self.offset
}
const fn icr_offset(&self) -> u32 {
(self.offset % 16) * 2
}
/// Returns `true` if the GPIO is set high.
pub fn is_set(&self) -> bool {
ral::read_reg!(ral::gpio, self.gpio, PSR) & self.mask() != 0
}
/// Returns `true` if the GPIO interrupt has triggered.
pub fn is_triggered(&self) -> bool {
ral::read_reg!(ral::gpio, self.gpio, ISR) & self.mask() != 0
}
/// Clear the interrupt triggered flag.
pub fn clear_triggered(&self) {
// Atomic write; OK to take immutable reference.
ral::write_reg!(ral::gpio, self.gpio, ISR, self.mask());
}
/// Indicates if interrupts are enabled for this input.
pub fn is_interrupt_enabled(&self) -> bool {
ral::read_reg!(ral::gpio, self.gpio, IMR) & self.mask() != 0
}
/// Release the underlying pin object.
pub fn release(self) -> P {
self.pin
}
/// Access the underlying pin.
pub fn pin(&self) -> &P {
&self.pin
}
/// Mutably access the underling pin.
pub fn pin_mut(&mut self) -> &mut P {
&mut self.pin
}
}
impl Input<()> {
/// Allocate an input GPIO without a pin.
///
/// Prefer using [`Port::input`](Port::input) to create a GPIO ouptut with a
/// pin resource. That method ensures that pin resources are managed throughout
/// your program, and that the pin is configured to operate as a GPIO input.
///
/// You may use this method to allocate duplicate `Input` object for the same
/// physical GPIO input. This is considered safe, since the `Input` API is
/// reentrant. Any non-reentrant methods are attached to [`Port`], which cannot
/// be constructed without an `unsafe` constructor of the register block.
///
/// If you use this constructor, you're responsible for configuring the IOMUX
/// multiplexer register.
pub fn without_pin<const N: u8>(port: &mut Port<N>, offset: u32) -> Self {
Self::new((), port.register_block(), offset)
}
}
impl<P> eh02::digital::v2::OutputPin for Output<P> {
type Error = core::convert::Infallible;
fn set_high(&mut self) -> Result<(), Self::Error> {
self.set();
Ok(())
}
fn set_low(&mut self) -> Result<(), Self::Error> {
self.clear();
Ok(())
}
}
#[cfg(feature = "eh02-unproven")]
impl<P> eh02::digital::v2::StatefulOutputPin for Output<P> {
fn is_set_high(&self) -> Result<bool, Self::Error> {
Ok(self.is_set())
}
fn is_set_low(&self) -> Result<bool, Self::Error> {
Ok(!self.is_set())
}
}
#[cfg(feature = "eh02-unproven")]
impl<P> eh02::digital::v2::ToggleableOutputPin for Output<P> {
type Error = core::convert::Infallible;
fn toggle(&mut self) -> Result<(), Self::Error> {
Output::<P>::toggle(self);
Ok(())
}
}
#[cfg(feature = "eh02-unproven")]
impl<P> eh02::digital::v2::InputPin for Input<P> {
type Error = core::convert::Infallible;
fn is_high(&self) -> Result<bool, Self::Error> {
Ok(self.is_set())
}
fn is_low(&self) -> Result<bool, Self::Error> {
Ok(!self.is_set())
}
}
impl<P> eh1::digital::ErrorType for Output<P> {
type Error = core::convert::Infallible;
}
impl<P> eh1::digital::OutputPin for Output<P> {
fn set_high(&mut self) -> Result<(), Self::Error> {
Output::set(self);
Ok(())
}
fn set_low(&mut self) -> Result<(), Self::Error> {
Output::clear(self);
Ok(())
}
}
impl<P> eh1::digital::StatefulOutputPin for Output<P> {
fn is_set_high(&mut self) -> Result<bool, Self::Error> {
Ok(Output::is_set(self))
}
fn is_set_low(&mut self) -> Result<bool, Self::Error> {
Ok(!Output::is_set(self))
}
fn toggle(&mut self) -> Result<(), Self::Error> {
Output::toggle(self);
Ok(())
}
}
// For open drain or simply reading back the actual state
// of the pin.
impl<P> eh1::digital::InputPin for Output<P> {
fn is_high(&mut self) -> Result<bool, Self::Error> {
Ok(Output::is_pad_high(self))
}
fn is_low(&mut self) -> Result<bool, Self::Error> {
Ok(!Output::is_pad_high(self))
}
}
impl<P> eh1::digital::ErrorType for Input<P> {
type Error = core::convert::Infallible;
}
impl<P> eh1::digital::InputPin for Input<P> {
fn is_high(&mut self) -> Result<bool, Self::Error> {
Ok(Input::is_set(self))
}
fn is_low(&mut self) -> Result<bool, Self::Error> {
Ok(!Input::is_set(self))
}
}