Merge branch 'release_candidate' into main

Author: PaulZC

Binaries/OpenLog_Artemis-V10-v23-NoPowerLossProtection.bin

@@ -152,7 +152,10 @@ const int FIRMWARE_VERSION_MINOR = 3;
 //    the minor firmware version
 #define OLA_IDENTIFIER 0x123 // Stored as 291 decimal in OLA_settings.txt
 
+//#define noPowerLossProtection // Uncomment this line to disable the sleep-on-power-loss functionality
+
 #include "Sensors.h"
+
 #include "settings.h"
 
 //Define the pin functions
@@ -358,15 +361,53 @@ Stream *ZSERIAL;
 // Serial output for debugging info for Zmodem
 Stream *DSERIAL;
 
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+#include "WDT.h" // WDT support
+
+volatile static bool petTheDog = true; // Flag to control whether the WDT ISR pets (resets) the timer.
+
+// Interrupt handler for the watchdog.
+extern "C" void am_watchdog_isr(void)
+{
+  // Clear the watchdog interrupt.
+  wdt.clear();
+
+  // Restart the watchdog if petTheDog is true
+  if (petTheDog)
+    wdt.restart(); // "Pet" the dog.
+}
+
+void startWatchdog()
+{
+  // Set watchdog timer clock to 16 Hz
+  // Set watchdog interrupt to 1 seconds (16 ticks / 16 Hz = 1 second)
+  // Set watchdog reset to 1.25 seconds (20 ticks / 16 Hz = 1.25 seconds)
+  // Note: Ticks are limited to 255 (8-bit)
+  wdt.configure(WDT_16HZ, 16, 20);
+  wdt.start(); // Start the watchdog
+}
+
+void stopWatchdog()
+{
+  wdt.stop();
+}
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
 void setup() {
   //If 3.3V rail drops below 3V, system will power down and maintain RTC
   pinMode(PIN_POWER_LOSS, INPUT); // BD49K30G-TL has CMOS output and does not need a pull-up
 
   delay(1); // Let PIN_POWER_LOSS stabilize
 
+#ifndef noPowerLossProtection
   if (digitalRead(PIN_POWER_LOSS) == LOW) powerDownOLA(); //Check PIN_POWER_LOSS just in case we missed the falling edge
   //attachInterrupt(PIN_POWER_LOSS, powerDownOLA, FALLING); // We can't do this with v2.1.0 as attachInterrupt causes a spontaneous interrupt
   attachInterrupt(PIN_POWER_LOSS, powerLossISR, FALLING);
+#else
+  // No Power Loss Protection
+  // Set up the WDT to generate a reset just in case the code crashes during a brown-out
+  startWatchdog();
+#endif
   powerLossSeen = false; // Make sure the flag is clear
 
   powerLEDOn(); // Turn the power LED on - if the hardware supports it

Firmware/OpenLog_Artemis/OpenLog_Artemis.ino

@@ -30,12 +30,21 @@ void checkBattery(void)
 
         delay(sdPowerDownDelay); // Give the SD card time to finish writing ***** THIS IS CRITICAL *****
 
+#ifdef noPowerLossProtection
+        SerialPrintln(F("*** LOW BATTERY VOLTAGE DETECTED! RESETTING... ***"));
+        SerialPrintln(F("*** PLEASE CHANGE THE POWER SOURCE TO CONTINUE ***"));
+      
+        SerialFlush(); //Finish any prints
+
+        resetArtemis(); // Reset the Artemis so we don't get stuck in a low voltage infinite loop
+#else
         SerialPrintln(F("***      LOW BATTERY VOLTAGE DETECTED! GOING INTO POWERDOWN      ***"));
         SerialPrintln(F("*** PLEASE CHANGE THE POWER SOURCE AND RESET THE OLA TO CONTINUE ***"));
 
         SerialFlush(); //Finish any prints
 
-        powerDownOLA(); // power down and wait for reset
+        powerDownOLA(); // Power down and wait for reset
+#endif
       }
     }
     else
@@ -45,8 +54,10 @@ void checkBattery(void)
   }
 #endif
 
+#ifndef noPowerLossProtection // Redundant - since the interrupt is not attached if noPowerLossProtection is defined... But you never know...
   if (powerLossSeen)
     powerDownOLA(); // power down and wait for reset
+#endif
 }
 
 //Power down the entire system but maintain running of RTC
@@ -55,8 +66,10 @@ void checkBattery(void)
 //With leakage across the 3.3V protection diode, it's approx 3.00uA.
 void powerDownOLA(void)
 {
+#ifndef noPowerLossProtection // Probably redundant - included just in case detachInterrupt causes badness when it has not been attached
   //Prevent voltage supervisor from waking us from sleep
   detachInterrupt(PIN_POWER_LOSS);
+#endif
 
   //Prevent stop logging button from waking us from sleep
   if (settings.useGPIO32ForStopLogging == true)
@@ -140,6 +153,10 @@ void powerDownOLA(void)
   qwiicPowerOff();
 #endif
 
+#ifdef noPowerLossProtection // If noPowerLossProtection is defined, then the WDT will already be running
+  stopWatchdog();
+#endif
+
   //Power down cache, flash, SRAM
   am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); // Power down all flash and cache
   am_hal_pwrctrl_memory_deepsleep_retain(AM_HAL_PWRCTRL_MEM_SRAM_384K); // Retain all SRAM
@@ -222,7 +239,10 @@ void resetArtemis(void)
   powerLEDOff();
 
   //Enable the Watchdog so it can reset the Artemis
-  startWatchdog();
+  petTheDog = false; // Make sure the WDT will not restart
+#ifndef noPowerLossProtection // If noPowerLossProtection is defined, then the WDT will already be running
+  startWatchdog(); // Start the WDT to generate a reset
+#endif
   while (1) // That's all folks! Artemis will reset in 1.25 seconds
     ;
 }
@@ -232,8 +252,10 @@ void goToSleep(uint32_t sysTicksToSleep)
 {
   printDebug("goToSleep: sysTicksToSleep = " + (String)sysTicksToSleep + "\r\n");
 
+#ifndef noPowerLossProtection // Probably redundant - included just in case detachInterrupt causes badness when it has not been attached
   //Prevent voltage supervisor from waking us from sleep
   detachInterrupt(PIN_POWER_LOSS);
+#endif
 
   //Prevent stop logging button from waking us from sleep
   if (settings.useGPIO32ForStopLogging == true)
@@ -351,6 +373,13 @@ void goToSleep(uint32_t sysTicksToSleep)
   else
     powerLEDOff();
 
+
+#ifdef noPowerLossProtection
+  // If noPowerLossProtection is defined, then the WDT will be running
+  // We need to stop it otherwise it will wake the Artemis
+  stopWatchdog();
+#endif
+
   //Power down cache, flash, SRAM
   am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); // Power down all flash and cache
   am_hal_pwrctrl_memory_deepsleep_retain(AM_HAL_PWRCTRL_MEM_SRAM_384K); // Retain all SRAM
@@ -420,12 +449,17 @@ void wakeFromSleep()
 
   delay(1); // Let PIN_POWER_LOSS stabilize
 
+#ifndef noPowerLossProtection
   if (digitalRead(PIN_POWER_LOSS) == LOW) powerDownOLA(); //Check PIN_POWER_LOSS just in case we missed the falling edge
-
   //attachInterrupt(PIN_POWER_LOSS, powerDownOLA, FALLING); // We can't do this with v2.1.0 as attachInterrupt causes a spontaneous interrupt
   attachInterrupt(PIN_POWER_LOSS, powerLossISR, FALLING);
+#else
+  // No Power Loss Protection
+  // Set up the WDT to generate a reset just in case the code crashes during a brown-out
+  startWatchdog();
+#endif
   powerLossSeen = false; // Make sure the flag is clear
-  
+
   if (settings.useGPIO32ForStopLogging == true)
   {
     pinMode(PIN_STOP_LOGGING, INPUT_PULLUP);
@@ -704,46 +738,3 @@ int calculateDayOfYear(int day, int month, int year)
   doy += day;
   return doy;
 }
-
-//WatchDog Timer code by Adam Garbo:
-//https://forum.sparkfun.com/viewtopic.php?f=169&t=52431&p=213296#p213296
-
-// Watchdog timer configuration structure.
-am_hal_wdt_config_t g_sWatchdogConfig = {
-
-  // Configuration values for generated watchdog timer event.
-  .ui32Config = AM_HAL_WDT_LFRC_CLK_16HZ | AM_HAL_WDT_ENABLE_RESET | AM_HAL_WDT_ENABLE_INTERRUPT,
-
-  // Number of watchdog timer ticks allowed before a watchdog interrupt event is generated.
-  .ui16InterruptCount = 16, // Set WDT interrupt timeout for 1 second.
-
-  // Number of watchdog timer ticks allowed before the watchdog will issue a system reset.
-  .ui16ResetCount = 20 // Set WDT reset timeout for 1.25 seconds.
-};
-
-void startWatchdog()
-{
-  // LFRC must be turned on for this example as the watchdog only runs off of the LFRC.
-  am_hal_clkgen_control(AM_HAL_CLKGEN_CONTROL_LFRC_START, 0);
-
-  // Configure the watchdog.
-  am_hal_wdt_init(&g_sWatchdogConfig);
-
-  // Enable the interrupt for the watchdog in the NVIC.
-  NVIC_EnableIRQ(WDT_IRQn);
-  //NVIC_SetPriority(WDT_IRQn, 0); // Set the interrupt priority to 0 = highest (255 = lowest)
-  //am_hal_interrupt_master_enable(); // ap3_initialization.cpp does this - no need to do it here
-
-  // Enable the watchdog.
-  am_hal_wdt_start();
-}
-
-// Interrupt handler for the watchdog.
-extern "C++" void am_watchdog_isr(void)
-{
-  // Clear the watchdog interrupt.
-  am_hal_wdt_int_clear();
-
-  // DON'T Restart the watchdog.
-  //am_hal_wdt_restart(); // "Pet" the dog.
-}

Firmware/OpenLog_Artemis/lowerPower.ino

@@ -562,7 +562,9 @@ void productionTest()
         break;
       case 0x55: // Deep sleep
       {
+#ifndef noPowerLossProtection // Probably redundant - included just in case detachInterrupt causes badness when it has not been attached
         detachInterrupt(PIN_POWER_LOSS); // Disable power loss interrupt
+#endif
         Serial.end(); //Power down UART
         //Force the peripherals off
         //am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM0);