Add custom AtomicWaker

esp-hal/CHANGELOG.md

@@ -39,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - I8080: Added `set_8bits_order()` to set the byte order in 8-bit mode (#2487)
 - `I2c::{apply_config(), with_sda(), with_scl()}` (#2477)
 - ESP32-S2: Added missing GPIO alternate functions (#2512)
+- `esp_hal::asynch::AtomicWaker` that does not hold a global critical section (#2555)
 
 ### Changed
 

esp-hal/src/dma/gdma.rs

@@ -116,7 +116,7 @@ impl<const N: u8> GdmaChannel for SpecificGdmaChannel<N> {
 #[doc(hidden)]
 pub struct ChannelTxImpl<C: GdmaChannel>(C);
 
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 
 static TX_WAKERS: [AtomicWaker; CHANNEL_COUNT] = [const { AtomicWaker::new() }; CHANNEL_COUNT];
 static RX_WAKERS: [AtomicWaker; CHANNEL_COUNT] = [const { AtomicWaker::new() }; CHANNEL_COUNT];

esp-hal/src/dma/mod.rs

@@ -1654,7 +1654,7 @@ pub trait Rx: crate::private::Sealed {
 
     fn clear_interrupts(&self);
 
-    fn waker(&self) -> &'static embassy_sync::waitqueue::AtomicWaker;
+    fn waker(&self) -> &'static crate::asynch::AtomicWaker;
 }
 
 // DMA receive channel
@@ -1898,7 +1898,7 @@ where
         self.rx_impl.clear_all();
     }
 
-    fn waker(&self) -> &'static embassy_sync::waitqueue::AtomicWaker {
+    fn waker(&self) -> &'static crate::asynch::AtomicWaker {
         self.rx_impl.waker()
     }
 }
@@ -1947,7 +1947,7 @@ pub trait Tx: crate::private::Sealed {
 
     fn clear_interrupts(&self);
 
-    fn waker(&self) -> &'static embassy_sync::waitqueue::AtomicWaker;
+    fn waker(&self) -> &'static crate::asynch::AtomicWaker;
 
     fn last_out_dscr_address(&self) -> usize;
 }
@@ -2180,7 +2180,7 @@ where
         self.tx_impl.pending_interrupts()
     }
 
-    fn waker(&self) -> &'static embassy_sync::waitqueue::AtomicWaker {
+    fn waker(&self) -> &'static crate::asynch::AtomicWaker {
         self.tx_impl.waker()
     }
 
@@ -2276,7 +2276,7 @@ pub trait InterruptAccess<T: EnumSetType>: crate::private::Sealed {
     fn is_listening(&self) -> EnumSet<T>;
     fn clear(&self, interrupts: impl Into<EnumSet<T>>);
     fn pending_interrupts(&self) -> EnumSet<T>;
-    fn waker(&self) -> &'static embassy_sync::waitqueue::AtomicWaker;
+    fn waker(&self) -> &'static crate::asynch::AtomicWaker;
 
     fn is_async(&self) -> bool;
     fn set_async(&self, is_async: bool);

esp-hal/src/dma/pdma.rs

@@ -11,7 +11,7 @@
 //! [SPI]: ../spi/index.html
 //! [I2S]: ../i2s/index.html
 
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 use portable_atomic::{AtomicBool, Ordering};
 
 use crate::{

esp-hal/src/gpio/mod.rs

@@ -1971,7 +1971,7 @@ fn handle_pin_interrupts(handle: impl Fn(u8)) {
 mod asynch {
     use core::task::{Context, Poll};
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use crate::asynch::AtomicWaker;
 
     use super::*;
 

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

@@ -45,7 +45,7 @@ use core::{
 };
 
 use embassy_embedded_hal::SetConfig;
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 use embedded_hal::i2c::Operation as EhalOperation;
 use fugit::HertzU32;
 

esp-hal/src/lcd_cam/mod.rs

@@ -10,7 +10,7 @@ pub mod lcd;
 
 use core::marker::PhantomData;
 
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 
 use crate::{
     interrupt::InterruptHandler,

esp-hal/src/lib.rs

@@ -570,3 +570,41 @@ pub fn init(config: Config) -> Peripherals {
 
     peripherals
 }
+
+/// Asynchronous utilities.
+pub mod asynch {
+    use core::task::Waker;
+
+    use crate::sync::Locked;
+
+    /// Utility struct to register and wake a waker.
+    pub struct AtomicWaker {
+        waker: Locked<Option<Waker>>,
+    }
+
+    impl AtomicWaker {
+        /// Create a new `AtomicWaker`.
+        pub const fn new() -> Self {
+            Self {
+                waker: Locked::new(None),
+            }
+        }
+
+        /// Register a waker. Overwrites the previous waker, if any.
+        pub fn register(&self, w: &Waker) {
+            self.waker.with(|waker| match waker {
+                Some(w2) if w2.will_wake(w) => {}
+                _ => *waker = Some(w.clone()),
+            })
+        }
+
+        /// Wake the registered waker, if any.
+        pub fn wake(&self) {
+            self.waker.with(|waker| {
+                if let Some(w) = waker {
+                    w.wake_by_ref();
+                }
+            })
+        }
+    }
+}

esp-hal/src/parl_io.rs

@@ -1491,11 +1491,11 @@ where
 pub mod asynch {
     use core::task::Poll;
 
-    use embassy_sync::waitqueue::AtomicWaker;
     use procmacros::handler;
 
     use super::{private::Instance, Error, ParlIoRx, ParlIoTx, MAX_DMA_SIZE};
     use crate::{
+        asynch::AtomicWaker,
         dma::{asynch::DmaRxFuture, ReadBuffer, WriteBuffer},
         peripherals::Interrupt,
     };

esp-hal/src/rmt.rs

@@ -84,11 +84,11 @@ use core::{
     task::{Context, Poll},
 };
 
-use embassy_sync::waitqueue::AtomicWaker;
 use enumset::{EnumSet, EnumSetType};
 use fugit::HertzU32;
 
 use crate::{
+    asynch::AtomicWaker,
     gpio::interconnect::{PeripheralInput, PeripheralOutput},
     macros::handler,
     peripheral::Peripheral,

esp-hal/src/rsa/mod.rs

@@ -376,7 +376,7 @@ where
 pub(crate) mod asynch {
     use core::task::Poll;
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use crate::asynch::AtomicWaker;
     use portable_atomic::{AtomicBool, Ordering};
     use procmacros::handler;
 

esp-hal/src/timer/systimer.rs

@@ -975,7 +975,7 @@ mod asynch {
         task::{Context, Poll},
     };
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use crate::asynch::AtomicWaker;
     use procmacros::handler;
 
     use super::*;

esp-hal/src/timer/timg.rs

@@ -1161,7 +1161,7 @@ mod asynch {
         task::{Context, Poll},
     };
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use crate::asynch::AtomicWaker;
     use procmacros::handler;
 
     use super::*;

esp-hal/src/touch.rs

@@ -527,10 +527,8 @@ mod asynch {
         task::{Context, Poll},
     };
 
-    use embassy_sync::waitqueue::AtomicWaker;
-
     use super::*;
-    use crate::{macros::ram, prelude::handler, Async};
+    use crate::{asynch::AtomicWaker, macros::ram, prelude::handler, Async};
 
     const NUM_TOUCH_PINS: usize = 10;
 

esp-hal/src/uart.rs

@@ -116,7 +116,7 @@
 use core::{marker::PhantomData, sync::atomic::Ordering, task::Poll};
 
 use embassy_embedded_hal::SetConfig;
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 use enumset::{EnumSet, EnumSetType};
 use portable_atomic::AtomicBool;
 

esp-hal/src/usb_serial_jtag.rs

@@ -77,7 +77,7 @@
 
 use core::{convert::Infallible, marker::PhantomData, task::Poll};
 
-use embassy_sync::waitqueue::AtomicWaker;
+use crate::asynch::AtomicWaker;
 use procmacros::handler;
 
 use crate::{

esp-wifi/src/ble/controller/mod.rs

@@ -93,7 +93,7 @@ pub(crate) mod asynch {
         HostToControllerPacket,
         WriteHci,
     };
-    use embassy_sync::waitqueue::AtomicWaker;
+    use esp_hal::asynch::AtomicWaker;
 
     use super::*;
     use crate::ble::have_hci_read_data;

esp-wifi/src/esp_now/mod.rs

@@ -884,7 +884,7 @@ pub use asynch::SendFuture;
 mod asynch {
     use core::task::{Context, Poll};
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use esp_hal::asynch::AtomicWaker;
 
     use super::*;
 

esp-wifi/src/wifi/mod.rs

@@ -3110,7 +3110,7 @@ macro_rules! esp_wifi_result {
 
 pub(crate) mod embassy {
     use embassy_net_driver::{Capabilities, Driver, HardwareAddress, RxToken, TxToken};
-    use embassy_sync::waitqueue::AtomicWaker;
+    use esp_hal::asynch::AtomicWaker;
 
     use super::*;
 
@@ -3197,7 +3197,7 @@ pub(crate) fn apply_power_saving(ps: PowerSaveMode) -> Result<(), WifiError> {
 mod asynch {
     use core::task::Poll;
 
-    use embassy_sync::waitqueue::AtomicWaker;
+    use esp_hal::asynch::AtomicWaker;
 
     use super::*;