Add sleep handler to optimize low-power sleep (#1418)

* Add sleep handler to optimize low-power sleep

* Add sleep handler to optimize low-power sleep

Committer: Sinisha Djukic <s.djukic@gmail.com>

Author:    Sinisha Djukic <s.djukic@gmail.com>
Date:      Wed May 13 08:51:48 2020 +0300
Committer: Sinisha Djukic <s.djukic@gmail.com>
	modified:   MyConfig.h
	modified:   core/MySensorsCore.cpp
	modified:   core/MySensorsCore.h
	modified:   keywords.txt

* Whitespace fixed

* Fixed compiler warning

Committer: Sinisha Djukic <s.djukic@gmail.com>
Author: Sinisha Djukic <s.djukic@gmail.com>

Co-authored-by: Djukic Sinisha (INST/RBR2-BG INST/ESU) <djs1wa3@bosch.com>

Author: SinishaDjukic

MyConfig.h

@@ -1217,6 +1217,16 @@
 #ifndef MY_SMART_SLEEP_WAIT_DURATION_MS
 #define MY_SMART_SLEEP_WAIT_DURATION_MS (500ul)
 #endif
+
+/**
+ * @def MY_SLEEP_HANDLER
+ * @brief Define this to enable the custom pre- & post-sleep handler.
+ *
+ * Sleep handler is invoked right before entering the sleep function, as well a just after the sleep
+ * completes. Applications can use this handler to turn off peripherals or put pins into a best
+ * possible low power state according to the concrete hardware design.
+ */
+//#define MY_SLEEP_HANDLER
 /** @}*/ // End of SleepSettingGrpPub group
 
 /**
@@ -1353,7 +1363,6 @@
 #define MY_INCLUSION_BUTTON_PRESSED (LOW)
 #endif
 
-
 /**************************************
 * Ethernet Gateway Transport Defaults
 ***************************************/
@@ -2329,6 +2338,7 @@
 #define MY_DISABLE_REMOTE_RESET
 #define MY_DISABLE_RAM_ROUTING_TABLE_FEATURE
 #define MY_LOCK_DEVICE
+#define MY_SLEEP_HANDLER
 // core
 #define MY_CORE_ONLY
 // GW

core/MySensorsCore.cpp

@@ -625,6 +625,15 @@ void doYield(void)
 #endif
 }
 
+#if !defined(MY_SLEEP_HANDLER)
+void sleepHandler(bool sleep)
+{
+	(void)sleep;
+	// empty function, resolves AVR-specific GCC optimization bug (<5.5) if handler not used
+	// see here: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=77326
+}
+#endif
+
 int8_t _sleep(const uint32_t sleepingMS, const bool smartSleep, const uint8_t interrupt1,
               const uint8_t mode1, const uint8_t interrupt2, const uint8_t mode2)
 {
@@ -707,6 +716,9 @@ int8_t _sleep(const uint32_t sleepingMS, const bool smartSleep, const uint8_t in
 	}
 #endif
 
+	// Call the sleep handler to turn off peripherals optimally
+	sleepHandler(true);
+
 	int8_t result = MY_SLEEP_NOT_POSSIBLE;	// default
 	if (interrupt1 != INTERRUPT_NOT_DEFINED && interrupt2 != INTERRUPT_NOT_DEFINED) {
 		// both IRQs
@@ -718,6 +730,10 @@ int8_t _sleep(const uint32_t sleepingMS, const bool smartSleep, const uint8_t in
 		// no IRQ
 		result = hwSleep(sleepingTimeMS);
 	}
+
+	// Call the sleep handler to turn on peripherals optimally
+	sleepHandler(false);
+
 	setIndication(INDICATION_WAKEUP);
 	CORE_DEBUG(PSTR("MCO:SLP:WUP=%" PRIi8 "\n"), result);	// sleep wake-up
 #if defined(MY_SENSOR_NETWORK)

core/MySensorsCore.h

@@ -301,6 +301,12 @@ bool wait(const uint32_t waitingMS, const mysensors_command_t cmd, const uint8_t
  */
 void doYield(void);
 
+/**
+ * Sleep handler will be called right before and right after entering sleep mode.
+ * Applications can define own handler to optimize powering down peripherals before entering sleep.
+ * @param sleep true if entering sleep, false if exiting
+ */
+void sleepHandler(bool sleep);
 
 /**
  * Sleep (PowerDownMode) the MCU and radio. Wake up on timer.

keywords.txt

@@ -45,6 +45,7 @@ MY_SERIAL_OUTPUT_SIZE	LITERAL1
 MY_SLEEP_NOT_POSSIBLE	LITERAL1
 MY_SPLASH_SCREEN_DISABLED	LITERAL1
 MY_WAKE_UP_BY_TIMER	LITERAL1
+MY_SLEEP_HANDLER	LITERAL1
 
 # transport
 AUTO	LITERAL1