Support extra parameter on attachInterrupt()

When writing an arduino library, it is difficult to connect interrupt handlers with the component instance that should be notified.

In C, the common pattern to fix this is to specifying a `void*` parameter with the callback, where the listener can store any context necessary.

This patch adds the new function `attachInterruptParam()` to implement this pattern.

Author: Paulo Costa

hardware/arduino/avr/cores/arduino/Arduino.h

@@ -140,6 +140,7 @@ void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
 uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
 
 void attachInterrupt(uint8_t, void (*)(void), int mode);
+void attachInterruptParam(uint8_t, void (*)(void*), int mode, void* param);
 void detachInterrupt(uint8_t);
 
 void setup(void);

hardware/arduino/avr/cores/arduino/WInterrupts.c

@@ -35,7 +35,7 @@
 static void nothing(void) {
 }
 
-static volatile voidFuncPtr intFunc[EXTERNAL_NUM_INTERRUPTS] = {
+static volatile voidFuncPtrParam intFunc[EXTERNAL_NUM_INTERRUPTS] = {
 #if EXTERNAL_NUM_INTERRUPTS > 8
     #warning There are more than 8 external interrupts. Some callbacks may not be initialized.
     nothing,
@@ -65,11 +65,23 @@ static volatile voidFuncPtr intFunc[EXTERNAL_NUM_INTERRUPTS] = {
     nothing,
 #endif
 };
+static volatile void* intFuncParam[EXTERNAL_NUM_INTERRUPTS];
 // volatile static voidFuncPtr twiIntFunc;
 
-void attachInterrupt(uint8_t interruptNum, void (*userFunc)(void), int mode) {
+void attachInterrupt(uint8_t interruptNum, voidFuncPtr userFunc, int mode) {
+  // THIS IMPLEMENTATION IS NOT PORTABLE!
+  // 
+  // On AVR's calling convention, calling a function with more arguments than it declares 
+  // is OK - The extra parameter is ignored and causes no harm
+  //
+  // This implementation takes advantage of it to support callbacks with and without parameters with minimum overhead.
+  attachInterruptParam(interruptNum, (voidFuncPtrParam)userFunc, mode, NULL);
+}
+
+void attachInterruptParam(uint8_t interruptNum, voidFuncPtrParam userFunc, int mode, void* param) {
   if(interruptNum < EXTERNAL_NUM_INTERRUPTS) {
     intFunc[interruptNum] = userFunc;
+    intFuncParam[interruptNum] = param;
 
     // Configure the interrupt mode (trigger on low input, any change, rising
     // edge, or falling edge).  The mode constants were chosen to correspond
@@ -271,6 +283,7 @@ void detachInterrupt(uint8_t interruptNum) {
     }
 
     intFunc[interruptNum] = nothing;
+    intFuncParam[interruptNum] = 0;
   }
 }
 
@@ -280,75 +293,37 @@ void attachInterruptTwi(void (*userFunc)(void) ) {
 }
 */
 
-#if defined(__AVR_ATmega32U4__)
-ISR(INT0_vect) {
-    intFunc[EXTERNAL_INT_0]();
-}
-
-ISR(INT1_vect) {
-    intFunc[EXTERNAL_INT_1]();
-}
-
-ISR(INT2_vect) {
-    intFunc[EXTERNAL_INT_2]();
-}
+#define IMPLEMENT_ISR(vect, interrupt) \
+  ISR(vect) { \
+    intFunc[interrupt](intFuncParam [interrupt]); \
+  }
 
-ISR(INT3_vect) {
-    intFunc[EXTERNAL_INT_3]();
-}
+#if defined(__AVR_ATmega32U4__)
 
-ISR(INT6_vect) {
-    intFunc[EXTERNAL_INT_4]();
-}
+IMPLEMENT_ISR(INT0_vect, EXTERNAL_INT_0)
+IMPLEMENT_ISR(INT1_vect, EXTERNAL_INT_1)
+IMPLEMENT_ISR(INT2_vect, EXTERNAL_INT_2)
+IMPLEMENT_ISR(INT3_vect, EXTERNAL_INT_3)
+IMPLEMENT_ISR(INT6_vect, EXTERNAL_INT_4)
 
 #elif defined(EICRA) && defined(EICRB)
 
-ISR(INT0_vect) {
-    intFunc[EXTERNAL_INT_2]();
-}
-
-ISR(INT1_vect) {
-    intFunc[EXTERNAL_INT_3]();
-}
-
-ISR(INT2_vect) {
-    intFunc[EXTERNAL_INT_4]();
-}
-
-ISR(INT3_vect) {
-    intFunc[EXTERNAL_INT_5]();
-}
-
-ISR(INT4_vect) {
-    intFunc[EXTERNAL_INT_0]();
-}
-
-ISR(INT5_vect) {
-    intFunc[EXTERNAL_INT_1]();
-}
-
-ISR(INT6_vect) {
-    intFunc[EXTERNAL_INT_6]();
-}
-
-ISR(INT7_vect) {
-    intFunc[EXTERNAL_INT_7]();
-}
+IMPLEMENT_ISR(INT0_vect, EXTERNAL_INT_2)
+IMPLEMENT_ISR(INT1_vect, EXTERNAL_INT_3)
+IMPLEMENT_ISR(INT2_vect, EXTERNAL_INT_4)
+IMPLEMENT_ISR(INT3_vect, EXTERNAL_INT_5)
+IMPLEMENT_ISR(INT4_vect, EXTERNAL_INT_0)
+IMPLEMENT_ISR(INT5_vect, EXTERNAL_INT_1)
+IMPLEMENT_ISR(INT6_vect, EXTERNAL_INT_6)
+IMPLEMENT_ISR(INT7_vect, EXTERNAL_INT_7)
 
 #else
 
-ISR(INT0_vect) {
-    intFunc[EXTERNAL_INT_0]();
-}
-
-ISR(INT1_vect) {
-    intFunc[EXTERNAL_INT_1]();
-}
+IMPLEMENT_ISR(INT0_vect, EXTERNAL_INT_0)
+IMPLEMENT_ISR(INT1_vect, EXTERNAL_INT_1)
 
 #if defined(EICRA) && defined(ISC20)
-ISR(INT2_vect) {
-    intFunc[EXTERNAL_INT_2]();
-}
+IMPLEMENT_ISR(INT2_vect, EXTERNAL_INT_2)
 #endif
 
 #endif
@@ -359,4 +334,3 @@ ISR(TWI_vect) {
     twiIntFunc();
 }
 */
-

hardware/arduino/avr/cores/arduino/wiring_private.h

@@ -64,6 +64,7 @@ uint32_t countPulseASM(volatile uint8_t *port, uint8_t bit, uint8_t stateMask, u
 #endif
 
 typedef void (*voidFuncPtr)(void);
+typedef void (*voidFuncPtrParam)(void*);
 
 #ifdef __cplusplus
 } // extern "C"