Remove the GPIO peripheral

esp-hal/CHANGELOG.md

@@ -171,6 +171,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SPI transactions are now cancelled if the transfer object (or async Future) is dropped. (#2216)
 - The DMA channel types have been removed from peripherals (#2261)
 - `I2C` driver renamed to `I2c` (#2320)
+- The  GPIO pins are now accessible via `Peripherals` and are no longer part of the `Io` struct (#2508)
 
 ### Fixed
 
@@ -215,6 +216,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed `esp_hal::spi::slave::WithDmaSpiN` traits (#2260)
 - The `WithDmaAes` trait has been removed (#2261)
 - The `I2s::new_i2s1` constructor has been removed (#2261)
+- `Peripherals.GPIO` has been removed (#2508)
 
 ## [0.20.1] - 2024-08-30
 

esp-hal/MIGRATING-0.21.md

@@ -1,5 +1,23 @@
 # Migration Guide from 0.21.x to v0.22.x
 
+## IO changes
+
+### GPIO pins are now accessible via `Peripherals`
+
+```diff
+ let peripherals = esp_hal::init(Default::default());
+-let io = Io::new(peripherals.GPIO, peripherals.IOMUX);
+-let pin = io.pins.gpio5;
++let pin = peripherals.pins.gpio5;
+```
+
+### `Io` constructor changes
+
+- `new_with_priority` and `new_no_bind_interrupts` have been removed.
+  Use `set_priority` to configure the GPIO interrupt priority.
+  We no longer overwrite interrupt handlers set by user code during initialization.
+- `new` no longer takes `peripherals.GPIO`
+
 ## Removed `async`-specific constructors
 
 The following async-specific constuctors have been removed:

esp-hal/src/analog/adc/mod.rs

@@ -31,10 +31,11 @@
 //! # use esp_hal::analog::adc::Attenuation;
 //! # use esp_hal::analog::adc::Adc;
 //! # use esp_hal::delay::Delay;
-//! # use esp_hal::gpio::Io;
-//! # let io = Io::new(peripherals.IO_MUX);
 #![cfg_attr(esp32, doc = "let analog_pin = peripherals.pins.gpio32;")]
-#![cfg_attr(any(esp32s2, esp32s3), doc = "let analog_pin = peripherals.pins.gpio3;")]
+#![cfg_attr(
+    any(esp32s2, esp32s3),
+    doc = "let analog_pin = peripherals.pins.gpio3;"
+)]
 #![cfg_attr(
     not(any(esp32, esp32s2, esp32s3)),
     doc = "let analog_pin = peripherals.pins.gpio2;"

esp-hal/src/analog/dac.rs

@@ -17,12 +17,9 @@
 //! ### Write a value to a DAC channel
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::analog::dac::Dac;
 //! # use esp_hal::delay::Delay;
 //! # use embedded_hal::delay::DelayNs;
-//!
-//! let io = Io::new(peripherals.IO_MUX);
 #![cfg_attr(esp32, doc = "let dac1_pin = peripherals.pins.gpio25;")]
 #![cfg_attr(esp32s2, doc = "let dac1_pin = peripherals.pins.gpio17;")]
 //! let mut dac1 = Dac::new(peripherals.DAC1, dac1_pin);

esp-hal/src/dma/mod.rs

@@ -18,13 +18,11 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::dma_buffers;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::spi::{master::{Config, Spi}, SpiMode};
 //! # use esp_hal::dma::{Dma, DmaPriority};
 //! let dma = Dma::new(peripherals.DMA);
 #![cfg_attr(any(esp32, esp32s2), doc = "let dma_channel = dma.spi2channel;")]
 #![cfg_attr(not(any(esp32, esp32s2)), doc = "let dma_channel = dma.channel0;")]
-//! let io = Io::new(peripherals.IO_MUX);
 //! let sclk = peripherals.pins.gpio0;
 //! let miso = peripherals.pins.gpio2;
 //! let mosi = peripherals.pins.gpio4;

esp-hal/src/etm.rs

@@ -23,13 +23,11 @@
 //! ## Examples
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::gpio::etm::{Channels, InputConfig, OutputConfig};
 //! # use esp_hal::etm::Etm;
 //! # use esp_hal::gpio::Pull;
 //! # use esp_hal::gpio::Level;
 //!
-//! let io = Io::new(peripherals.IO_MUX);
 //! let mut led = peripherals.pins.gpio1;
 //! let button = peripherals.pins.gpio9;
 //!

esp-hal/src/gpio/etm.rs

@@ -25,15 +25,13 @@
 //! ### Toggle an LED When a Button is Pressed
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::gpio::etm::Channels;
 //! # use esp_hal::etm::Etm;
 //! # use esp_hal::gpio::etm::InputConfig;
 //! # use esp_hal::gpio::etm::OutputConfig;
 //! # use esp_hal::gpio::Pull;
 //! # use esp_hal::gpio::Level;
 //! #
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut led = peripherals.pins.gpio1;
 //! # let button = peripherals.pins.gpio9;
 //!

esp-hal/src/gpio/lp_io.rs

@@ -15,15 +15,16 @@
 //! chip from Deep-sleep.
 //!
 //! # Example
+//!
 //! ## Configure a LP Pin as Output
+//!
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! use esp_hal::gpio::Io;
 //! use esp_hal::gpio::lp_io::LowPowerOutput;
-//! let io = Io::new(peripherals.IO_MUX);
 //! // configure GPIO 1 as LP output pin
 //! let lp_pin: LowPowerOutput<'_, 1> =
-//! LowPowerOutput::new(peripherals.pins.gpio1); # }
+//!     LowPowerOutput::new(peripherals.pins.gpio1);
+//! # }
 //! ```
 
 use core::marker::PhantomData;

esp-hal/src/gpio/mod.rs

@@ -18,9 +18,9 @@
 //! GPIO interrupts. For more information, see the
 //! [`Io::set_interrupt_handler`].
 //!
-//! The pins are accessible via [`Io::pins`]. These pins can then be passed to
-//! peripherals (such as SPI, UART, I2C, etc.), to pin drivers or can be
-//! [`GpioPin::split`] into peripheral signals.
+//! The pins are accessible via [`crate::Peripherals::pins`]. These pins can
+//! then be passed to peripherals (such as SPI, UART, I2C, etc.), to pin drivers
+//! or can be [`GpioPin::split`] into peripheral signals.
 //!
 //! Each pin is a different type initially. Internally, `esp-hal` will often
 //! erase their types automatically, but they can also be converted into
@@ -52,7 +52,6 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::gpio::{Io, Level, Output};
-//! let io = Io::new(peripherals.IO_MUX);
 //! let mut led = Output::new(peripherals.pins.gpio5, Level::High);
 //! # }
 //! ```

esp-hal/src/gpio/rtc_io.rs

@@ -23,8 +23,6 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::gpio::rtc_io::LowPowerOutput;
-//! # use esp_hal::gpio::Io;
-//! let io = Io::new(peripherals.IO_MUX);
 //! // configure GPIO 1 as ULP output pin
 //! let lp_pin = LowPowerOutput::<'static, 1>::new(peripherals.pins.gpio1);
 //! # }

esp-hal/src/i2c/master/mod.rs

@@ -19,7 +19,6 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::i2c::master::{Config, I2c};
-//! # use esp_hal::gpio::Io;
 //!
 //! // Create a new peripheral object with the described wiring
 //! // and standard I2C clock speed.

esp-hal/src/i2s/master.rs

@@ -30,10 +30,8 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::i2s::master::{I2s, Standard, DataFormat};
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::dma_buffers;
 //! # use esp_hal::dma::{Dma, DmaPriority};
-//! # let io = Io::new(peripherals.IO_MUX);
 //! let dma = Dma::new(peripherals.DMA);
 #![cfg_attr(any(esp32, esp32s2), doc = "let dma_channel = dma.i2s0channel;")]
 #![cfg_attr(not(any(esp32, esp32s2)), doc = "let dma_channel = dma.channel0;")]

esp-hal/src/lcd_cam/cam.rs

@@ -16,12 +16,10 @@
 //! master mode.
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::lcd_cam::{cam::{Camera, RxEightBits}, LcdCam};
 //! # use fugit::RateExtU32;
 //! # use esp_hal::dma_rx_stream_buffer;
 //! # use esp_hal::dma::{Dma, DmaPriority};
-//! # let io = Io::new(peripherals.IO_MUX);
 //!
 //! # let dma = Dma::new(peripherals.DMA);
 //! # let channel = dma.channel0;

esp-hal/src/lcd_cam/lcd/i8080.rs

@@ -15,11 +15,9 @@
 //!
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::lcd_cam::{LcdCam, lcd::i8080::{Config, I8080, TxEightBits}};
 //! # use esp_hal::dma_tx_buffer;
 //! # use esp_hal::dma::{Dma, DmaPriority, DmaTxBuf};
-//! # let io = Io::new(peripherals.IO_MUX);
 //!
 //! # let dma = Dma::new(peripherals.DMA);
 //! # let channel = dma.channel0;

esp-hal/src/ledc/mod.rs

@@ -29,8 +29,6 @@
 //! # use esp_hal::ledc::timer;
 //! # use esp_hal::ledc::LowSpeed;
 //! # use esp_hal::ledc::channel;
-//! # use esp_hal::gpio::Io;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let led = peripherals.pins.gpio0;
 //!
 //! let mut ledc = Ledc::new(peripherals.LEDC);

esp-hal/src/lib.rs

@@ -81,7 +81,6 @@
 //!     });
 //!
 //!     // Set GPIO0 as an output, and set its state high initially.
-//!     let io = Io::new(peripherals.IO_MUX);
 //!     let mut led = Output::new(peripherals.pins.gpio0, Level::High);
 //!
 //!     let delay = Delay::new();

esp-hal/src/mcpwm/mod.rs

@@ -52,9 +52,6 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::mcpwm::{operator::{DeadTimeCfg, PWMStream, PwmPinConfig}, timer::PwmWorkingMode, McPwm, PeripheralClockConfig};
-//! # use esp_hal::gpio::Io;
-//!
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let pin = peripherals.pins.gpio0;
 //!
 //! // initialize peripheral

esp-hal/src/mcpwm/operator.rs

@@ -479,8 +479,6 @@ impl<PWM: PwmPeripheral, const OP: u8, const IS_A: bool> embedded_hal::pwm::SetD
 /// # use esp_hal::{mcpwm, prelude::*};
 /// # use esp_hal::mcpwm::{McPwm, PeripheralClockConfig};
 /// # use esp_hal::mcpwm::operator::{DeadTimeCfg, PwmPinConfig, PWMStream};
-/// # use esp_hal::gpio::Io;
-/// # let io = Io::new(peripherals.IO_MUX);
 /// // active high complementary using PWMA input
 /// let bridge_active = DeadTimeCfg::new_ahc();
 /// // use PWMB as input for both outputs

esp-hal/src/rmt.rs

@@ -54,9 +54,7 @@
 //! # use esp_hal::peripherals::Peripherals;
 //! # use esp_hal::rmt::TxChannelConfig;
 //! # use esp_hal::rmt::Rmt;
-//! # use esp_hal::gpio::Io;
 //! # use crate::esp_hal::rmt::TxChannelCreator;
-//! # let io = Io::new(peripherals.IO_MUX);
 #![cfg_attr(esp32h2, doc = "let freq = 32.MHz();")]
 #![cfg_attr(not(esp32h2), doc = "let freq = 80.MHz();")]
 //! let rmt = Rmt::new(peripherals.RMT, freq).unwrap();

esp-hal/src/rng.rs

@@ -138,9 +138,7 @@ impl rand_core::RngCore for Rng {
 /// # use esp_hal::peripherals::Peripherals;
 /// # use esp_hal::peripherals::ADC1;
 /// # use esp_hal::analog::adc::{AdcConfig, Attenuation, Adc};
-/// # use esp_hal::gpio::Io;
 ///
-/// let io = Io::new(peripherals.IO_MUX);
 /// let mut buf = [0u8; 16];
 ///
 /// // ADC is not available from now
@@ -152,10 +150,12 @@ impl rand_core::RngCore for Rng {
 #[cfg_attr(esp32, doc = "let analog_pin = peripherals.pins.gpio32;")]
 #[cfg_attr(not(esp32), doc = "let analog_pin = peripherals.pins.gpio3;")]
 /// let mut adc1_config = AdcConfig::new();
-/// let mut adc1_pin = adc1_config.enable_pin(analog_pin,
-/// Attenuation::Attenuation11dB); let mut adc1 =
-/// Adc::<ADC1>::new(peripherals.ADC1, adc1_config); let pin_value: u16 =
-/// nb::block!(adc1.read_oneshot(&mut adc1_pin)).unwrap();
+/// let mut adc1_pin = adc1_config.enable_pin(
+///     analog_pin,
+///     Attenuation::Attenuation11dB
+/// );
+/// let mut adc1 = Adc::<ADC1>::new(peripherals.ADC1, adc1_config);
+/// let pin_value: u16 = nb::block!(adc1.read_oneshot(&mut adc1_pin)).unwrap();
 /// rng.read(&mut buf);
 /// true_rand = rng.random();
 /// let pin_value: u16 = nb::block!(adc1.read_oneshot(&mut adc1_pin)).unwrap();

esp-hal/src/rom/md5.rs

@@ -32,10 +32,8 @@
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::rom::md5;
 //! # use esp_hal::uart::Uart;
-//! # use esp_hal::gpio::Io;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut uart0 = Uart::new(peripherals.UART0, peripherals.pins.gpio1, peripherals.pins.gpio2).unwrap();
 //! # let data = "Dummy";
 //! let d: md5::Digest = md5::compute(&data);
@@ -48,10 +46,8 @@
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::rom::md5;
 //! # use esp_hal::uart::Uart;
-//! # use esp_hal::gpio::Io;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut uart0 = Uart::new(peripherals.UART0, peripherals.pins.gpio1, peripherals.pins.gpio2).unwrap();
 //! # let data0 = "Dummy";
 //! # let data1 = "Dummy";

esp-hal/src/soc/esp32/efuse/mod.rs

@@ -24,11 +24,9 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::efuse::Efuse;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::uart::Uart;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut serial_tx = Uart::new(peripherals.UART0, peripherals.pins.gpio4, peripherals.pins.gpio5).unwrap();
 //! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(

esp-hal/src/soc/esp32/peripherals.rs

@@ -33,7 +33,6 @@ crate::peripherals! {
     EFUSE <= EFUSE,
     FLASH_ENCRYPTION <= FLASH_ENCRYPTION,
     FRC_TIMER <= FRC_TIMER,
-    GPIO <= GPIO (GPIO,GPIO_NMI),
     GPIO_SD <= GPIO_SD,
     HINF <= HINF,
     I2C0 <= I2C0,

esp-hal/src/soc/esp32c2/efuse/mod.rs

@@ -21,11 +21,9 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::efuse::Efuse;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::uart::Uart;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut serial_tx = Uart::new(peripherals.UART0, peripherals.pins.gpio4, peripherals.pins.gpio5).unwrap();
 //! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(

esp-hal/src/soc/esp32c2/peripherals.rs

@@ -28,7 +28,6 @@ crate::peripherals! {
     ECC <= ECC,
     EFUSE <= EFUSE,
     EXTMEM <= EXTMEM,
-    GPIO <= GPIO (GPIO,GPIO_NMI),
     I2C0 <= I2C0,
     INTERRUPT_CORE0 <= INTERRUPT_CORE0,
     IO_MUX <= IO_MUX,

esp-hal/src/soc/esp32c3/efuse/mod.rs

@@ -22,11 +22,9 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::efuse::Efuse;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::uart::Uart;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut serial_tx = Uart::new(peripherals.UART0, peripherals.pins.gpio4, peripherals.pins.gpio5).unwrap();
 //! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(

esp-hal/src/soc/esp32c3/peripherals.rs

@@ -30,7 +30,6 @@ crate::peripherals! {
     DS <= DS,
     EFUSE <= EFUSE,
     EXTMEM <= EXTMEM,
-    GPIO <= GPIO (GPIO,GPIO_NMI),
     GPIO_SD <= GPIO_SD,
     HMAC <= HMAC,
     I2C0 <= I2C0,

esp-hal/src/soc/esp32c6/efuse/mod.rs

@@ -22,11 +22,9 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::efuse::Efuse;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::uart::Uart;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut serial_tx = Uart::new(peripherals.UART0, peripherals.pins.gpio4, peripherals.pins.gpio5).unwrap();
 //! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(

esp-hal/src/soc/esp32c6/peripherals.rs

@@ -30,7 +30,6 @@ crate::peripherals! {
     ECC <= ECC,
     EFUSE <= EFUSE,
     EXTMEM <= EXTMEM,
-    GPIO <= GPIO (GPIO,GPIO_NMI),
     GPIO_SD <= GPIO_SD,
     HINF <= HINF,
     HMAC <= HMAC,

esp-hal/src/soc/esp32h2/efuse/mod.rs

@@ -22,11 +22,9 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::efuse::Efuse;
-//! # use esp_hal::gpio::Io;
 //! # use esp_hal::uart::Uart;
 //! # use core::writeln;
 //! # use core::fmt::Write;
-//! # let io = Io::new(peripherals.IO_MUX);
 //! # let mut serial_tx = Uart::new(peripherals.UART0, peripherals.pins.gpio4, peripherals.pins.gpio5).unwrap();
 //! let mac_address = Efuse::read_base_mac_address();
 //! writeln!(