Panic if the user has bound an incompatible interrupt handler

esp-rs · Sep 16, 2024 · 5133906 · 5133906
1 parent 8b4c369
commit 5133906
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 6 deletions.
diff --git a/esp-hal/src/gpio/mod.rs b/esp-hal/src/gpio/mod.rs
@@ -76,6 +76,7 @@ use crate::{
     private::{self, Sealed},
     Cpu,
     InterruptConfigurable,
+    DEFAULT_INTERRUPT_HANDLER,
 };
 
 pub mod interconnect;
@@ -982,6 +983,7 @@ fn raise_gpio_interrupt_priority(core: Cpu, priority: Priority) {
     #[allow(clippy::declare_interior_mutable_const)]
     const NO_PRIO: AtomicUsize = AtomicUsize::new(Priority::None as usize);
     static MAX_PRIO: [AtomicUsize; Cpu::COUNT] = [NO_PRIO; Cpu::COUNT];
+    static INTERNAL_HANDLER: extern "C" fn() = gpio_interrupt_handler;
 
     #[cold]
     fn do_raise_priority_level(max: &AtomicUsize, mut current_prio: usize, priority: Priority) {
@@ -994,12 +996,25 @@ fn raise_gpio_interrupt_priority(core: Cpu, priority: Priority) {
                 Ordering::Relaxed,
             ) {
                 Ok(_) => {
+                    let current_handler =
+                        crate::interrupt::bound_handler(crate::peripherals::Interrupt::GPIO);
+
+                    if let Some(handler) = current_handler {
+                        if handler != DEFAULT_INTERRUPT_HANDLER.handler() {
+                            assert!(
+                                handler == INTERNAL_HANDLER,
+                                "The GPIO interrupt handler is already bound."
+                            );
+                        }
+                    }
+
                     unsafe {
                         crate::interrupt::bind_interrupt(
                             crate::peripherals::Interrupt::GPIO,
-                            gpio_interrupt_handler,
+                            INTERNAL_HANDLER,
                         );
                     }
+
                     crate::interrupt::enable(crate::peripherals::Interrupt::GPIO, priority)
                         .unwrap();
                 }

diff --git a/esp-hal/src/interrupt/riscv.rs b/esp-hal/src/interrupt/riscv.rs
@@ -427,12 +427,24 @@ mod vectored {
     /// # Safety
     ///
     /// This will replace any previously bound interrupt handler
-    pub unsafe fn bind_interrupt(interrupt: Interrupt, handler: unsafe extern "C" fn() -> ()) {
+    pub unsafe fn bind_interrupt(interrupt: Interrupt, handler: unsafe extern "C" fn()) {
         let ptr = &peripherals::__EXTERNAL_INTERRUPTS[interrupt as usize]._handler as *const _
-            as *mut unsafe extern "C" fn() -> ();
+            as *mut unsafe extern "C" fn();
         ptr.write_volatile(handler);
     }
 
+    /// Returns the currently bound interrupt handler.
+    pub fn bound_handler(interrupt: Interrupt) -> Option<unsafe extern "C" fn()> {
+        unsafe {
+            let addr = peripherals::__EXTERNAL_INTERRUPTS[interrupt as usize]._handler;
+            if addr as usize == 0 {
+                return None;
+            }
+
+            Some(addr)
+        }
+    }
+
     #[no_mangle]
     #[ram]
     unsafe fn handle_interrupts(cpu_intr: CpuInterrupt, context: &mut TrapFrame) {

diff --git a/esp-hal/src/interrupt/xtensa.rs b/esp-hal/src/interrupt/xtensa.rs
@@ -419,12 +419,24 @@ mod vectored {
     /// # Safety
     ///
     /// This will replace any previously bound interrupt handler
-    pub unsafe fn bind_interrupt(interrupt: Interrupt, handler: unsafe extern "C" fn() -> ()) {
+    pub unsafe fn bind_interrupt(interrupt: Interrupt, handler: unsafe extern "C" fn()) {
         let ptr = &peripherals::__INTERRUPTS[interrupt as usize]._handler as *const _
-            as *mut unsafe extern "C" fn() -> ();
+            as *mut unsafe extern "C" fn();
         ptr.write_volatile(handler);
     }
 
+    /// Returns the currently bound interrupt handler.
+    pub fn bound_handler(interrupt: Interrupt) -> Option<unsafe extern "C" fn()> {
+        unsafe {
+            let addr = peripherals::__INTERRUPTS[interrupt as usize]._handler;
+            if addr as usize == 0 {
+                return None;
+            }
+
+            Some(addr)
+        }
+    }
+
     fn interrupt_level_to_cpu_interrupt(
         level: Priority,
         is_edge: bool,

diff --git a/esp-hal/src/peripheral.rs b/esp-hal/src/peripheral.rs
@@ -329,7 +329,7 @@ mod peripheral_macros {
                         $(
                             paste::paste!{
                                 /// Binds an interrupt handler to the corresponding interrupt for this peripheral.
-                                pub fn [<bind_ $interrupt:lower _interrupt >](&mut self, handler: unsafe extern "C" fn() -> ()) {
+                                pub fn [<bind_ $interrupt:lower _interrupt >](&mut self, handler: unsafe extern "C" fn()) {
                                     unsafe { $crate::interrupt::bind_interrupt($crate::peripherals::Interrupt::$interrupt, handler); }
                                 }
                             }