Remove the need to manually pass clocks around (#1999)

* Clean up passing clocks to drivers

* Update changelog

* Initialise Clocks in a critical section

* Fix calling now() before init

* Fix doc

* Fix esp-wifi migration guide

* Add safety comment

* Update tests

Author: bugadani

esp-hal-embassy/CHANGELOG.md

@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed the `clocks` parameter from `esp_hal_embassy::init`. (#1999)
+
 ## 0.3.0 - 2024-08-29
 
 ### Added

esp-hal-embassy/MIGRATING-0.3.md

@@ -0,0 +1,30 @@
+Migration Guide from 0.3.x to vNext
+====================================
+
+Initialsation
+-------------
+
+You no longer have to set up clocks and pass them to `esp_hal_embassy::init`.
+
+```diff
+ use esp_hal::{
+-    clock::ClockControl,
+-    peripherals::Peripherals,
+     prelude::*,
+-    system::SystemControl,
+ };
+ 
+ #[esp_hal_embassy::main]
+ async fn main(_spawner: Spawner) -> ! {
+-    let peripherals = Peripherals::take();
+-    let system = SystemControl::new(peripherals.SYSTEM);
+-    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
++    let peripherals = esp_hal::init(esp_hal::Config::default());
+
+     let timg0 = TimerGroup::new(peripherals.TIMG0);
+-    esp_hal_embassy::init(&clocks, timg0);
++    esp_hal_embassy::init(timg0);
+
+     // ...
+ }
+```

esp-hal-embassy/src/lib.rs

@@ -38,10 +38,7 @@ mod fmt;
 
 #[cfg(not(feature = "esp32"))]
 use esp_hal::timer::systimer::Alarm;
-use esp_hal::{
-    clock::Clocks,
-    timer::{timg::Timer as TimgTimer, ErasedTimer},
-};
+use esp_hal::timer::{timg::Timer as TimgTimer, ErasedTimer};
 pub use macros::main;
 
 #[cfg(feature = "executors")]
@@ -158,12 +155,12 @@ impl_array!(4);
 #[doc = esp_hal::before_snippet!()]
 /// use esp_hal::timg::TimerGroup;
 ///
-/// let timg0 = TimerGroup::new(peripherals.TIMG0, &clocks);
-/// esp_hal_embassy::init(&clocks, timg0.timer0);
+/// let timg0 = TimerGroup::new(peripherals.TIMG0);
+/// esp_hal_embassy::init(timg0.timer0);
 ///
 /// // ... now you can spawn embassy tasks or use `Timer::after` etc.
 /// # }
 /// ```
-pub fn init(clocks: &Clocks, time_driver: impl TimerCollection) {
-    EmbassyTimer::init(clocks, time_driver.timers())
+pub fn init(time_driver: impl TimerCollection) {
+    EmbassyTimer::init(time_driver.timers())
 }

esp-hal-embassy/src/time_driver.rs

@@ -3,7 +3,6 @@ use core::cell::{Cell, RefCell};
 use critical_section::Mutex;
 use embassy_time_driver::{AlarmHandle, Driver};
 use esp_hal::{
-    clock::Clocks,
     interrupt::{InterruptHandler, Priority},
     prelude::*,
     time::current_time,
@@ -45,7 +44,7 @@ embassy_time_driver::time_driver_impl!(static DRIVER: EmbassyTimer = EmbassyTime
 });
 
 impl EmbassyTimer {
-    pub(super) fn init(_clocks: &Clocks, timers: &'static mut [Timer]) {
+    pub(super) fn init(timers: &'static mut [Timer]) {
         if timers.len() > MAX_SUPPORTED_ALARM_COUNT {
             panic!(
                 "Maximum of {} timers can be used.",

esp-hal-smartled/CHANGELOG.md

@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed the `clocks` parameter from `SmartLedsAdapter::new` (#1999)
+
 ## 0.13.0 - 2024-08-29
 
 ## 0.12.0 - 2024-07-15

esp-hal-smartled/src/lib.rs

@@ -12,10 +12,10 @@
 //!
 //! ```rust,ignore
 //! let io = Io::new(peripherals.GPIO, peripherals.IO_MUX);
-//! let rmt = Rmt::new(peripherals.RMT, 80.MHz(), &clocks, None).unwrap();
+//! let rmt = Rmt::new(peripherals.RMT, 80.MHz(), None).unwrap();
 //!
 //! let rmt_buffer = smartLedBuffer!(1);
-//! let mut led = SmartLedsAdapter::new(rmt.channel0, io.pins.gpio2, rmt_buffer, &clocks);
+//! let mut led = SmartLedsAdapter::new(rmt.channel0, io.pins.gpio2, rmt_buffer);
 //! ```
 //!
 //! ## Feature Flags
@@ -89,7 +89,6 @@ where
         channel: C,
         pin: impl Peripheral<P = O> + 'd,
         rmt_buffer: [u32; BUFFER_SIZE],
-        clocks: &Clocks,
     ) -> SmartLedsAdapter<TX, BUFFER_SIZE>
     where
         O: OutputPin + 'd,
@@ -107,6 +106,7 @@ where
         let channel = channel.configure(pin, config).unwrap();
 
         // Assume the RMT peripheral is set up to use the APB clock
+        let clocks = Clocks::get();
         let src_clock = clocks.apb_clock.to_MHz();
 
         Self {

esp-hal/CHANGELOG.md

@@ -10,10 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Implement `embedded-hal` output pin traits for `DummyPin` (#2019)
-- Added `esp_hal::init` to simplify HAL initialisation (#1970)
+- Added `esp_hal::init` to simplify HAL initialisation (#1970, #1999)
 
 ### Changed
 
+- `Delay::new()` is now a `const` function (#1999)
+
 ### Fixed
 
 - Fixed an issue with DMA transfers potentially not waking up the correct async task (#2065)
@@ -23,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed `NoPinType` in favour of `DummyPin`. (#2068)
 - Removed the `async`, `embedded-hal-02`, `embedded-hal`, `embedded-io`, `embedded-io-async`, and `ufmt` features (#2070)
 - Removed the `GpioN` type aliasses. Use `GpioPin<N>` instead. (#2073)
+- Removed `Peripherals::take`. Use `esp_hal::init` to obtain `Peripherals` (#1999)
 
 ## [0.20.1] - 2024-08-30
 

esp-hal/Cargo.toml

@@ -139,6 +139,7 @@ defmt = [
     "esp32h2?/defmt",
     "esp32s2?/defmt",
     "esp32s3?/defmt",
+    "fugit/defmt",
 ]
 
 #! ### PSRAM Feature Flags

esp-hal/MIGRATING-0.20.md

@@ -30,7 +30,7 @@ Instead of manually grabbing peripherals and setting up clocks, you should now c
 -    let peripherals = Peripherals::take();
 -    let system = SystemControl::new(peripherals.SYSTEM);
 -    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
-+    let (peripherals, clocks) = esp_hal::init(esp_hal::Config::default());
++    let peripherals = esp_hal::init(esp_hal::Config::default());
 
      // ...
  }

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

@@ -46,7 +46,7 @@
 //! );
 //! let mut adc1 = Adc::new(peripherals.ADC1, adc1_config);
 //!
-//! let mut delay = Delay::new(&clocks);
+//! let mut delay = Delay::new();
 //!
 //! loop {
 //!     let pin_value: u16 = nb::block!(adc1.read_oneshot(&mut pin)).unwrap();