Pass state of sdSemaphore into factoryReset()

Fix for issue #519

Author: nseidle

Firmware/RTK_Surveyor/Begin.ino

@@ -980,7 +980,7 @@ void beginSystemState()
     if (systemState > STATE_NOT_SET)
     {
         systemPrintln("Unknown state - factory reset");
-        factoryReset();
+        factoryReset(false); //We do not have the SD semaphore
     }
 
     if (productVariant == RTK_SURVEYOR)

Firmware/RTK_Surveyor/Form.ino

@@ -1350,7 +1350,7 @@ void updateSettingWithValue(const char *settingName, const char *settingValueStr
             requestChangeState(STATE_ROVER_NOT_STARTED); // If update failed, return to Rover mode.
     }
     else if (strcmp(settingName, "factoryDefaultReset") == 0)
-        factoryReset();
+        factoryReset(false); //We do not have the sdSemaphore
     else if (strcmp(settingName, "exitAndReset") == 0)
     {
         // Confirm receipt

Firmware/RTK_Surveyor/NVM.ino

@@ -738,7 +738,8 @@ bool parseLine(char *str, Settings *settings)
         // If user sets sizeOfSettings to -1 in config file, RTK Surveyor will factory reset
         if (d == -1)
         {
-            factoryReset(); // Erase file system, erase settings file, reset u-blox module, display message on OLED
+            // Erase file system, erase settings file, reset u-blox module, display message on OLED
+            factoryReset(true); //We already have the SD semaphore
         }
 
         // Check to see if this setting file is compatible with this version of RTK Surveyor

Firmware/RTK_Surveyor/menuMain.ino

@@ -37,9 +37,9 @@ void menuMain()
         systemPrint("** Bluetooth broadcasting as: ");
         systemPrint(deviceName);
         systemPrintln(" **");
-#else   // COMPILE_BT
+#else  // COMPILE_BT
         systemPrintln("** Bluetooth Not Compiled **");
-#endif  // COMPILE_BT
+#endif // COMPILE_BT
 
         systemPrintln("Menu: Main");
 
@@ -58,25 +58,25 @@ void menuMain()
 
 #ifdef COMPILE_WIFI
         systemPrintln("6) Configure WiFi");
-#else   // COMPILE_WIFI
+#else  // COMPILE_WIFI
         systemPrintln("6) **WiFi Not Compiled**");
-#endif  // COMPILE_WIFI
+#endif // COMPILE_WIFI
 
 #ifdef COMPILE_ETHERNET
         if (HAS_ETHERNET)
         {
             systemPrintln("e) Configure Ethernet");
             systemPrintln("n) Configure NTP");
         }
-#endif  // COMPILE_ETHERNET
+#endif // COMPILE_ETHERNET
 
         systemPrintln("p) Configure User Profiles");
 
 #ifdef COMPILE_ESPNOW
         systemPrintln("r) Configure Radios");
-#else   // COMPILE_ESPNOW
+#else  // COMPILE_ESPNOW
         systemPrintln("r) **ESP-Now Not Compiled**");
-#endif  // COMPILE_ESPNOW
+#endif // COMPILE_ESPNOW
 
         if (online.lband == true)
             systemPrintln("P) Configure PointPerfect");
@@ -119,7 +119,7 @@ void menuMain()
 #ifdef COMPILE_ESPNOW
         else if (incoming == 'r')
             menuRadio();
-#endif  // COMPILE_ESPNOW
+#endif // COMPILE_ESPNOW
         else if (incoming == 'f')
             menuFirmware();
         else if (incoming == 'b')
@@ -262,7 +262,7 @@ void menuUserProfiles()
                         if (SD_MMC.exists(settingsFileName))
                             SD_MMC.remove(settingsFileName);
                     }
-#endif  // COMPILE_SD_MMC
+#endif // COMPILE_SD_MMC
                 }
 
                 recordProfileNumber(0); // Move to Profile1
@@ -334,18 +334,22 @@ void changeProfileNumber(byte newProfileNumber)
 }
 
 // Erase all settings. Upon restart, unit will use defaults
-void factoryReset()
+void factoryReset(bool alreadyHasSemaphore)
 {
     displaySytemReset(); // Display friendly message on OLED
 
     tasksStopUART2();
 
+    Serial.println("remove old files");
+
     // Attempt to write to file system. This avoids collisions with file writing from other functions like
-    // recordSystemSettingsToFile() and F9PSerialReadTask() if (settings.enableSD && online.microSD) //Don't check
-    // settings.enableSD - it could be corrupt
+    // recordSystemSettingsToFile() and F9PSerialReadTask() if (settings.enableSD && online.microSD) 
+    //Don't check settings.enableSD - it could be corrupt
     if (online.microSD)
     {
-        if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    Serial.println("2 - remove old files");
+
+        if (alreadyHasSemaphore == true || xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
         {
             if (USE_SPI_MICROSD)
             {
@@ -363,16 +367,20 @@ void factoryReset()
                 SD_MMC.remove(stationCoordinateECEFFileName); // Remove station files
                 SD_MMC.remove(stationCoordinateGeodeticFileName);
             }
-#endif  // COMPILE_SD_MMC
+#endif // COMPILE_SD_MMC
 
             xSemaphoreGive(sdCardSemaphore);
         } // End sdCardSemaphore
         else
         {
+            char semaphoreHolder[50];
+            getSemaphoreFunction(semaphoreHolder);
+
             // An error occurs when a settings file is on the microSD card and it is not
             // deleted, as such the settings on the microSD card will be loaded when the
             // RTK reboots, resulting in failure to achieve the factory reset condition
-            systemPrintf("sdCardSemaphore failed to yield, menuMain.ino line %d\r\n", __LINE__);
+            log_d("sdCardSemaphore failed to yield, held by %s, menuMain.ino line %d\r\n", semaphoreHolder,
+                  __LINE__);
         }
     }
 
@@ -512,5 +520,5 @@ void menuRadio()
     radioStart();
 
     clearBuffer(); // Empty buffer of any newline chars
-#endif  // COMPILE_ESPNOW
+#endif             // COMPILE_ESPNOW
 }

Firmware/RTK_Surveyor/menuSystem.ino

@@ -327,7 +327,7 @@ void menuSystem()
             byte bContinue = getCharacterNumber();
             if (bContinue == 'y')
             {
-                factoryReset();
+                factoryReset(false); //We do not have the SD semaphore 
             }
             else
                 systemPrintln("Reset aborted");