Remove prelude

esp-hal-embassy/src/time_driver.rs

@@ -3,9 +3,8 @@ use core::cell::Cell;
 use embassy_time_driver::{AlarmHandle, Driver};
 use esp_hal::{
     interrupt::{InterruptHandler, Priority},
-    prelude::*,
     sync::Locked,
-    time::now,
+    time::{now, ExtU64},
     timer::{AnyTimer, OneShotTimer},
     Blocking,
 };

esp-hal/CHANGELOG.md

@@ -49,6 +49,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `gpio::{Level, Pull, AlternateFunction, RtcFunction}` now implement `Hash` (#2842)
 - `gpio::{GpioPin, AnyPin, Io, Output, OutputOpenDrain, Input, Flex}` now implement `Debug`, `defmt::Format` (#2842)
 
+- The `ExtU64` and `RateExtU32` traits have been added to `esp_hal::time` (#2845)
+
 ### Changed
 
 - Bump MSRV to 1.83 (#2615)
@@ -104,6 +106,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed `Camera::set_` functions (#2610)
 - `DmaTxBuf::{compute_chunk_size, compute_descriptor_count, new_with_block_size}` (#2543)
 
+- The `prelude` module has been removed (#2845)
+
 ## [0.22.0] - 2024-11-20
 
 ### Added

esp-hal/MIGRATING-0.22.md

@@ -317,3 +317,22 @@ To avoid abbreviations and contractions (as per the esp-hal guidelines), some er
 - Error::InvalidZeroLength
 + Error::ZeroLengthInvalid
 ```
+
+## The crate prelude has been removed
+
+The reexports that were previously part of the prelude are available through other paths:
+
+- `nb` is no longer re-exported. Please import the `nb` crate if you need it.
+- `ExtU64` and `RateExtU32` have been moved to `esp_hal::time`
+- `Clock` and `CpuClock`: `esp_hal::clock::{Clock, CpuClock}`
+- The following traits need to be individually imported when needed:
+    - `esp_hal::analog::dac::Instance`
+    - `esp_hal::gpio::Pin`
+    - `esp_hal::ledc::channel::ChannelHW`
+    - `esp_hal::ledc::channel::ChannelIFace`
+    - `esp_hal::ledc::timer::TimerHW`
+    - `esp_hal::ledc::timer::TimerIFace`
+    - `esp_hal::timer::timg::TimerGroupInstance`
+    - `esp_hal::timer::Timer`
+    - `esp_hal::interrupt::InterruptConfigurable`
+- The `entry` macro can be imported as `esp_hal::entry`, while other macros are found under `esp_hal::macros`

esp-hal/src/clock/mod.rs

@@ -37,6 +37,8 @@
 //! ### Initialize With Different Clock Frequencies
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
+//! use esp_hal::clock::CpuClock;
+//!
 //! // Initialize with the highest possible frequency for this chip
 //! let config = esp_hal::Config::default().with_cpu_clock(CpuClock::max());
 //! let peripherals = esp_hal::init(config);

esp-hal/src/config.rs

@@ -22,6 +22,8 @@
 //! ### Custom initialization
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
+//! use esp_hal::clock::CpuClock;
+//!
 //! let config =
 //! esp_hal::Config::default().with_cpu_clock(CpuClock::max()).
 //!     with_watchdog(esp_hal::config::WatchdogConfig::default().

esp-hal/src/i2s/parallel.rs

@@ -43,7 +43,6 @@
 //! # use esp_hal::dma_buffers;
 //! # use esp_hal::delay::Delay;
 //! # use esp_hal::i2s::parallel::{I2sParallel, TxEightBits};
-//! # use esp_hal::prelude::*;
 //!
 //! const BUFFER_SIZE: usize = 256;
 //!

esp-hal/src/lib.rs

@@ -68,9 +68,10 @@
 //! #     loop {}
 //! # }
 //! use esp_hal::{
+//!     clock::CpuClock,
 //!     delay::Delay,
+//!     entry,
 //!     gpio::{Io, Level, Output},
-//!     prelude::*,
 //! };
 //!
 //! #[entry]
@@ -178,7 +179,6 @@ pub mod i2c;
 #[cfg(any(dport, interrupt_core0, interrupt_core1))]
 pub mod interrupt;
 pub mod peripheral;
-pub mod prelude;
 #[cfg(any(hmac, sha))]
 mod reg_access;
 #[cfg(any(spi0, spi1, spi2, spi3))]

esp-hal/src/macros.rs

@@ -13,9 +13,8 @@ macro_rules! before_snippet {
     () => {
         r#"
 # #![no_std]
-# use esp_hal::prelude::*;
 # use procmacros::handler;
-# use esp_hal::interrupt;
+# use esp_hal::{interrupt::{self, InterruptConfigurable}, time::{RateExtU32 as _, ExtU64 as _}};
 # macro_rules! println {
 #     ($($tt:tt)*) => { };
 # }

esp-hal/src/mcpwm/operator.rs

@@ -453,7 +453,6 @@ impl<PWM: PwmPeripheral, const OP: u8, const IS_A: bool> embedded_hal::pwm::SetD
 ///
 /// ```rust, no_run
 #[doc = crate::before_snippet!()]
-/// # use esp_hal::{mcpwm, prelude::*};
 /// # use esp_hal::mcpwm::{McPwm, PeripheralClockConfig};
 /// # use esp_hal::mcpwm::operator::{DeadTimeCfg, PwmPinConfig, PWMStream};
 /// // active high complementary using PWMA input

esp-hal/src/rmt.rs

@@ -81,7 +81,6 @@
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::rmt::{PulseCode, Rmt, TxChannel, TxChannelConfig, TxChannelCreator};
 //! # use esp_hal::delay::Delay;
-//! # use esp_hal::prelude::*;
 //!
 //! // Configure frequency based on chip type
 #![cfg_attr(esp32h2, doc = "let freq = 32.MHz();")]
@@ -117,7 +116,6 @@
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::rmt::{PulseCode, Rmt, RxChannel, RxChannelConfig, RxChannelCreator};
 //! # use esp_hal::delay::Delay;
-//! # use esp_hal::prelude::*;
 //! # use esp_hal::gpio::{Level, Output};
 //!
 //! const WIDTH: usize = 80;

esp-hal/src/rng.rs

@@ -42,7 +42,7 @@
 //!
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::{prelude::*, rng::Rng};
+//! # use esp_hal::rng::Rng;
 //!
 //! let mut rng = Rng::new(peripherals.RNG);
 //!

esp-hal/src/rtc_cntl/mod.rs

@@ -23,7 +23,7 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use core::time::Duration;
-//! # use esp_hal::{delay::Delay, prelude::*, rtc_cntl::Rtc};
+//! # use esp_hal::{delay::Delay, rtc_cntl::Rtc};
 //!
 //! let rtc = Rtc::new(peripherals.LPWR);
 //! let delay = Delay::new();
@@ -90,7 +90,7 @@
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
 //! # use core::time::Duration;
-//! # use esp_hal::{delay::Delay, prelude::*, rtc_cntl::Rtc};
+//! # use esp_hal::{delay::Delay, rtc_cntl::Rtc};
 //!
 //! let rtc = Rtc::new(peripherals.LPWR);
 //! let delay = Delay::new();

esp-hal/src/rtc_cntl/sleep/mod.rs

@@ -55,7 +55,6 @@ pub enum WakeupLevel {
 #[doc = crate::before_snippet!()]
 /// # use core::time::Duration;
 /// # use esp_hal::delay::Delay;
-/// # use esp_hal::prelude::*;
 /// # use esp_hal::rtc_cntl::{reset_reason, sleep::TimerWakeupSource, wakeup_cause, Rtc, SocResetReason};
 /// # use esp_hal::Cpu;
 ///
@@ -104,7 +103,6 @@ pub enum Error {
 #[doc = crate::before_snippet!()]
 /// # use core::time::Duration;
 /// # use esp_hal::delay::Delay;
-/// # use esp_hal::prelude::*;
 /// # use esp_hal::rtc_cntl::{reset_reason, sleep::{Ext0WakeupSource, TimerWakeupSource, WakeupLevel}, wakeup_cause, Rtc, SocResetReason};
 /// # use esp_hal::Cpu;
 /// # use esp_hal::gpio::{Input, Pull};
@@ -155,7 +153,6 @@ impl<'a, P: RtcIoWakeupPinType> Ext0WakeupSource<'a, P> {
 #[doc = crate::before_snippet!()]
 /// # use core::time::Duration;
 /// # use esp_hal::delay::Delay;
-/// # use esp_hal::prelude::*;
 /// # use esp_hal::rtc_cntl::{reset_reason, sleep::{Ext1WakeupSource, TimerWakeupSource, WakeupLevel}, wakeup_cause, Rtc, SocResetReason};
 /// # use esp_hal::Cpu;
 /// # use esp_hal::gpio::{Input, Pull, RtcPin};
@@ -210,7 +207,6 @@ impl<'a, 'b> Ext1WakeupSource<'a, 'b> {
 #[doc = crate::before_snippet!()]
 /// # use core::time::Duration;
 /// # use esp_hal::delay::Delay;
-/// # use esp_hal::prelude::*;
 /// # use esp_hal::rtc_cntl::{reset_reason, sleep::{Ext1WakeupSource, TimerWakeupSource, WakeupLevel}, wakeup_cause, Rtc, SocResetReason};
 /// # use esp_hal::Cpu;
 /// # use esp_hal::gpio::{Input, Pull, RtcPinWithResistors};
@@ -268,7 +264,6 @@ impl<'a, 'b> Ext1WakeupSource<'a, 'b> {
 /// # use core::time::Duration;
 /// # use esp_hal::delay::Delay;
 /// # use esp_hal::gpio::{self, Input, Pull};
-/// # use esp_hal::prelude::*;
 /// # use esp_hal::rtc_cntl::{reset_reason, sleep::{RtcioWakeupSource, TimerWakeupSource, WakeupLevel}, wakeup_cause, Rtc, SocResetReason};
 /// # use esp_hal::Cpu;
 /// # use esp_hal::peripheral::Peripheral;

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

@@ -22,7 +22,7 @@
 //! # extern crate alloc;
 //! # use alloc::{string::String, vec::Vec};
 //! # use esp_alloc as _;
-//! # use esp_hal::{psram, prelude::*};
+//! # use esp_hal::psram;
 //!
 //! // Initialize PSRAM and add it as a heap memory region
 //! fn init_psram_heap(start: *mut u8, size: usize) {

esp-hal/src/soc/esp32s2/psram.rs

@@ -22,7 +22,7 @@
 //! # extern crate alloc;
 //! # use alloc::{string::String, vec::Vec};
 //! # use esp_alloc as _;
-//! # use esp_hal::{psram, prelude::*};
+//! # use esp_hal::psram;
 //!
 //! // Initialize PSRAM and add it as a heap memory region
 //! fn init_psram_heap(start: *mut u8, size: usize) {

esp-hal/src/soc/esp32s3/psram.rs

@@ -27,7 +27,7 @@
 //! # extern crate alloc;
 //! # use alloc::{string::String, vec::Vec};
 //! # use esp_alloc as _;
-//! # use esp_hal::{psram, prelude::*};
+//! # use esp_hal::psram;
 //!
 //! // Initialize PSRAM and add it as a heap memory region
 //! fn init_psram_heap(start: *mut u8, size: usize) {

esp-hal/src/spi/master.rs

@@ -75,10 +75,9 @@ use crate::{
     clock::Clocks,
     dma::{DmaChannelFor, DmaEligible, DmaRxBuffer, DmaTxBuffer, Rx, Tx},
     gpio::{interconnect::PeripheralOutput, InputSignal, NoPin, OutputSignal},
-    interrupt::InterruptHandler,
+    interrupt::{InterruptConfigurable, InterruptHandler},
     peripheral::{Peripheral, PeripheralRef},
     peripherals::spi2::RegisterBlock,
-    prelude::InterruptConfigurable,
     private,
     private::Sealed,
     spi::AnySpi,

esp-hal/src/time.rs

@@ -2,6 +2,8 @@
 //!
 //! The `time` module offers a way to get the system now.
 
+pub use fugit::{ExtU64, RateExtU32};
+
 /// Represents a duration of time.
 ///
 /// The resolution is 1 microsecond, represented as a 64-bit unsigned integer.

esp-hal/src/timer/systimer.rs

@@ -429,7 +429,7 @@ impl Alarm {
 
             static mut HANDLERS: [Option<extern "C" fn()>; 3] = [None, None, None];
 
-            #[crate::prelude::ram]
+            #[crate::macros::ram]
             unsafe extern "C" fn _handle_interrupt<const CH: u8>() {
                 if unsafe { &*SYSTIMER::PTR }
                     .int_raw()

esp-hal/src/timer/timg.rs

@@ -26,7 +26,8 @@
 //!
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::timer::timg::TimerGroup;
+//! use esp_hal::timer::timg::TimerGroup;
+//! use esp_hal::timer::Timer;
 //!
 //! let timg0 = TimerGroup::new(peripherals.TIMG0);
 //! let timer0 = timg0.timer0;
@@ -49,8 +50,9 @@
 //! ### Watchdog Timer
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::timer::timg::TimerGroup;
-//! # use esp_hal::timer::timg::MwdtStage;
+//! use esp_hal::timer::timg::TimerGroup;
+//! use esp_hal::timer::timg::MwdtStage;
+//! use esp_hal::timer::Timer;
 //!
 //! let timg0 = TimerGroup::new(peripherals.TIMG0);
 //! let mut wdt = timg0.wdt;

esp-hal/src/touch.rs

@@ -29,9 +29,9 @@ use core::marker::PhantomData;
 
 use crate::{
     gpio::TouchPin,
+    interrupt::InterruptConfigurable,
     peripheral::{Peripheral, PeripheralRef},
     peripherals::{RTC_CNTL, SENS, TOUCH},
-    prelude::*,
     private::{Internal, Sealed},
     rtc_cntl::Rtc,
     Async,
@@ -528,7 +528,11 @@ mod asynch {
     };
 
     use super::*;
-    use crate::{asynch::AtomicWaker, macros::ram, prelude::handler, Async};
+    use crate::{
+        asynch::AtomicWaker,
+        macros::{handler, ram},
+        Async,
+    };
 
     const NUM_TOUCH_PINS: usize = 10;
 

esp-hal/src/uart.rs

@@ -125,7 +125,6 @@
 #![doc = crate::before_snippet!()]
 //! # use esp_hal::delay::Delay;
 //! # use esp_hal::uart::{AtCmdConfig, Config, Uart, UartInterrupt};
-//! # use esp_hal::prelude::*;
 //! let delay = Delay::new();
 //!
 //! // Default pins for UART/Serial communication

esp-hal/src/usb_serial_jtag.rs

@@ -73,7 +73,7 @@
 //! ### How to output text using USB Serial/JTAG.
 //! ```rust, no_run
 #![doc = crate::before_snippet!()]
-//! # use esp_hal::{delay::Delay, prelude::*, usb_serial_jtag::UsbSerialJtag, Blocking};
+//! # use esp_hal::{delay::Delay, usb_serial_jtag::UsbSerialJtag, Blocking};
 //!
 //! let delay = Delay::new();
 //!

esp-ieee802154/src/raw.rs

@@ -3,8 +3,8 @@ use core::{cell::RefCell, ptr::addr_of};
 use critical_section::Mutex;
 use esp_hal::{
     interrupt::Priority,
+    macros::handler,
     peripherals::RADIO_CLK,
-    prelude::handler,
     system::{RadioClockController, RadioPeripherals},
 };
 use esp_wifi_sys::include::{

esp-wifi/src/common_adapter/common_adapter_esp32.rs

@@ -4,7 +4,7 @@ use super::phy_init_data::PHY_INIT_DATA_DEFAULT;
 use crate::{
     binary::include::*,
     hal::{
-        prelude::ram,
+        macros::ram,
         system::{RadioClockController, RadioPeripherals},
     },
 };

esp-wifi/src/common_adapter/common_adapter_esp32s2.rs

@@ -4,7 +4,7 @@ use super::phy_init_data::PHY_INIT_DATA_DEFAULT;
 use crate::{
     binary::include::*,
     hal::{
-        prelude::ram,
+        macros::ram,
         system::{RadioClockController, RadioPeripherals},
     },
 };