ESP32/ESP8266: place ISR in IRAM (#1348)

Author: tekka007

core/Version.h

@@ -50,7 +50,7 @@
 #define MYSENSORS_LIBRARY_VERSION_MINOR							3							//!< Minor release version
 #define MYSENSORS_LIBRARY_VERSION_PATCH							2							//!< Patch version
 #define MYSENSORS_LIBRARY_VERSION_PRERELEASE					"beta"						//!< Pre-release suffix, i.e. alpha, beta, rc.1, etc
-#define MYSENSORS_LIBRARY_VERSION_PRERELEASE_NUMBER				0x07						//!< incremental counter, starting at 0x00. 0xFF for final release
+#define MYSENSORS_LIBRARY_VERSION_PRERELEASE_NUMBER				0x08						//!< incremental counter, starting at 0x00. 0xFF for final release
 
 
 #if (MYSENSORS_LIBRARY_VERSION_PRERELEASE_NUMBER != 0xFF)

examples/EnergyMeterPulseSensor/EnergyMeterPulseSensor.ino

@@ -68,6 +68,33 @@ MyMessage wattMsg(CHILD_ID, V_WATT);
 MyMessage kWhMsg(CHILD_ID, V_KWH);
 MyMessage pcMsg(CHILD_ID, V_VAR1);
 
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+#define IRQ_HANDLER_ATTR ICACHE_RAM_ATTR
+#else
+#define IRQ_HANDLER_ATTR
+#endif
+
+void IRQ_HANDLER_ATTR onPulse()
+{
+	if (!SLEEP_MODE) {
+		uint32_t newBlinkmicros = micros();
+		uint32_t newBlinkmillis = millis();
+		uint32_t intervalmicros = newBlinkmicros - lastBlinkmicros;
+		uint32_t intervalmillis = newBlinkmillis - lastBlinkmillis;
+		if (intervalmicros < 10000L && intervalmillis < 10L) { // Sometimes we get interrupt on RISING
+			return;
+		}
+		if (intervalmillis < 360000) { // Less than an hour since last pulse, use microseconds
+			watt = (3600000000.0 / intervalmicros) / ppwh;
+		} else {
+			watt = (3600000.0 / intervalmillis) /
+			       ppwh; // more thAn an hour since last pulse, use milliseconds as micros will overflow after 70min
+		}
+		lastBlinkmicros = newBlinkmicros;
+		lastBlinkmillis = newBlinkmillis;
+	}
+	pulseCount++;
+}
 
 void setup()
 {
@@ -127,7 +154,7 @@ void loop()
 	}
 
 	if (SLEEP_MODE) {
-		sleep(SEND_FREQUENCY);
+		sleep(SEND_FREQUENCY, false);
 	}
 }
 
@@ -140,25 +167,3 @@ void receive(const MyMessage &message)
 		pcReceived = true;
 	}
 }
-
-void onPulse()
-{
-	if (!SLEEP_MODE) {
-		uint32_t newBlinkmicros = micros();
-		uint32_t newBlinkmillis = millis();
-		uint32_t intervalmicros = newBlinkmicros - lastBlinkmicros;
-		uint32_t intervalmillis = newBlinkmillis - lastBlinkmillis;
-		if (intervalmicros < 10000L && intervalmillis < 10L) { // Sometimes we get interrupt on RISING
-			return;
-		}
-		if (intervalmillis < 360000) { // Less than an hour since last pulse, use microseconds
-			watt = (3600000000.0 / intervalmicros) / ppwh;
-		} else {
-			watt = (3600000.0 / intervalmillis) /
-			       ppwh; // more thAn an hour since last pulse, use milliseconds as micros will overflow after 70min
-		}
-		lastBlinkmicros = newBlinkmicros;
-		lastBlinkmillis = newBlinkmillis;
-	}
-	pulseCount++;
-}

examples/WaterMeterPulseSensor/WaterMeterPulseSensor.ino

@@ -74,6 +74,31 @@ double oldvolume =0;
 uint32_t lastSend =0;
 uint32_t lastPulse =0;
 
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+#define IRQ_HANDLER_ATTR ICACHE_RAM_ATTR
+#else
+#define IRQ_HANDLER_ATTR
+#endif
+
+void IRQ_HANDLER_ATTR onPulse()
+{
+	if (!SLEEP_MODE) {
+		uint32_t newBlink = micros();
+		uint32_t interval = newBlink-lastBlink;
+
+		if (interval!=0) {
+			lastPulse = millis();
+			if (interval<500000L) {
+				// Sometimes we get interrupt on RISING,  500000 = 0.5 second debounce ( max 120 l/min)
+				return;
+			}
+			flow = (60000000.0 /interval) / ppl;
+		}
+		lastBlink = newBlink;
+	}
+	pulseCount++;
+}
+
 void setup()
 {
 	// initialize our digital pins internal pullup resistor so one pulse switches from high to low (less distortion)
@@ -151,7 +176,7 @@ void loop()
 		}
 	}
 	if (SLEEP_MODE) {
-		sleep(SEND_FREQUENCY);
+		sleep(SEND_FREQUENCY, false);
 	}
 }
 
@@ -167,21 +192,3 @@ void receive(const MyMessage &message)
 	}
 }
 
-void onPulse()
-{
-	if (!SLEEP_MODE) {
-		uint32_t newBlink = micros();
-		uint32_t interval = newBlink-lastBlink;
-
-		if (interval!=0) {
-			lastPulse = millis();
-			if (interval<500000L) {
-				// Sometimes we get interrupt on RISING,  500000 = 0.5 second debounce ( max 120 l/min)
-				return;
-			}
-			flow = (60000000.0 /interval) / ppl;
-		}
-		lastBlink = newBlink;
-	}
-	pulseCount++;
-}

hal/architecture/MyHwHAL.h

@@ -38,6 +38,16 @@
 */
 #define MY_HWID_PADDING_BYTE	(0xAAu)
 
+/**
+* @def IRQ_HANDLER_ATTR
+* @brief ESP8266/ESP32 IRQ handlers need to be stored in IRAM
+*/
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
+#define IRQ_HANDLER_ATTR ICACHE_RAM_ATTR
+#else
+#define IRQ_HANDLER_ATTR
+#endif
+
 // Implement these as functions or macros
 /*
 #define hwInit() MY_SERIALDEVICE.begin(BAUD_RATE)

hal/transport/RF24/driver/RF24.cpp

@@ -455,7 +455,7 @@ LOCAL bool RF24_getReceivedPowerDetector(void)
 }
 
 #if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
-LOCAL void RF24_irqHandler(void)
+LOCAL void IRQ_HANDLER_ATTR RF24_irqHandler(void)
 {
 	if (RF24_receiveCallback) {
 #if defined(MY_GATEWAY_SERIAL) && !defined(__linux__)

hal/transport/RFM69/driver/new/RFM69_new.cpp

@@ -242,7 +242,7 @@ LOCAL void RFM69_clearFIFO(void)
 	(void)RFM69_writeReg(RFM69_REG_IRQFLAGS2, RFM69_IRQFLAGS2_FIFOOVERRUN);
 }
 // IRQ handler: PayloadReady (RX) & PacketSent (TX) mapped to DI0
-LOCAL void RFM69_interruptHandler(void)
+LOCAL void IRQ_HANDLER_ATTR RFM69_interruptHandler(void)
 {
 	// set flag
 	RFM69_irq = true;

hal/transport/RFM69/driver/old/RFM69_old.cpp

@@ -414,7 +414,7 @@ void RFM69::sendFrame(uint8_t toAddress, const void* buffer, uint8_t bufferSize,
 }
 
 // internal function - interrupt gets called when a packet is received
-void RFM69::interruptHandler()
+void IRQ_HANDLER_ATTR RFM69::interruptHandler()
 {
 	//hwPinMode(4, OUTPUT);
 	//hwDigitalWrite(4, 1);
@@ -461,7 +461,7 @@ void RFM69::interruptHandler()
 }
 
 // internal function
-void RFM69::isr0()
+void IRQ_HANDLER_ATTR RFM69::isr0()
 {
 	selfPointer->interruptHandler();
 }

hal/transport/RFM95/driver/RFM95.cpp

@@ -233,7 +233,7 @@ LOCAL bool RFM95_initialise(const uint32_t frequencyHz)
 	return true;
 }
 
-LOCAL void RFM95_interruptHandler(void)
+LOCAL void IRQ_HANDLER_ATTR RFM95_interruptHandler(void)
 {
 	// set flag
 	RFM95_irq = true;