Merge pull request #136 from LeeLeahy2/semaphore

Change semaphore name from xFATSemaphore to sdCardSemaphore

Author: nseidle

Firmware/RTK_Surveyor/Begin.ino

@@ -241,11 +241,11 @@ void beginSD()
     }
 
     //Setup FAT file access semaphore
-    if (xFATSemaphore == NULL)
+    if (sdCardSemaphore == NULL)
     {
-      xFATSemaphore = xSemaphoreCreateMutex();
-      if (xFATSemaphore != NULL)
-        xSemaphoreGive(xFATSemaphore);  //Make the file system available for use
+      sdCardSemaphore = xSemaphoreCreateMutex();
+      if (sdCardSemaphore != NULL)
+        xSemaphoreGive(sdCardSemaphore);  //Make the file system available for use
     }
 
     if (createTestFile() == false)

Firmware/RTK_Surveyor/Buttons.ino

@@ -23,13 +23,17 @@ void powerDown(bool displayInfo)
   {
     //Attempt to write to file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile()
     //Wait up to 1000ms
-    if (xSemaphoreTake(xFATSemaphore, 1000 / portTICK_PERIOD_MS) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, 1000 / portTICK_PERIOD_MS) == pdPASS)
     {
       //Close down file system
       ubxFile.sync();
       ubxFile.close();
-      //xSemaphoreGive(xFATSemaphore); //Do not release semaphore
-    } //End xFATSemaphore
+      //xSemaphoreGive(sdCardSemaphore); //Do not release semaphore
+    } //End sdCardSemaphore
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
+    }
 
     online.logging = false;
   }

Firmware/RTK_Surveyor/NVM.ino

@@ -62,7 +62,7 @@ void recordSystemSettingsToFileSD(char *fileName)
   if (online.microSD == true)
   {
     //Attempt to write to file system. This avoids collisions with file writing from other functions like updateLogs()
-    if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {
       if (sd.exists(fileName))
         sd.remove(fileName);
@@ -84,7 +84,11 @@ void recordSystemSettingsToFileSD(char *fileName)
 
       log_d("Settings recorded to SD: %s", fileName);
 
-      xSemaphoreGive(xFATSemaphore);
+      xSemaphoreGive(sdCardSemaphore);
+    }
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
     }
   }
 }
@@ -226,15 +230,15 @@ bool loadSystemSettingsFromFileSD(char* fileName, Settings *settings)
   if (online.microSD == true)
   {
     //Attempt to access file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile() and F9PSerialReadTask()
-    if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {
       if (sd.exists(fileName))
       {
         SdFile settingsFile; //FAT32
         if (settingsFile.open(fileName, O_READ) == false)
         {
           Serial.println(F("Failed to open settings file"));
-          xSemaphoreGive(xFATSemaphore);
+          xSemaphoreGive(sdCardSemaphore);
           return (false);
         }
 
@@ -255,7 +259,7 @@ bool loadSystemSettingsFromFileSD(char* fileName, Settings *settings)
             {
               //If we can't read the first line of the settings file, give up
               Serial.println(F("Giving up on settings file"));
-              xSemaphoreGive(xFATSemaphore);
+              xSemaphoreGive(sdCardSemaphore);
               return (false);
             }
           }
@@ -265,7 +269,7 @@ bool loadSystemSettingsFromFileSD(char* fileName, Settings *settings)
             {
               //If we can't read the first line of the settings file, give up
               Serial.println(F("Giving up on settings file"));
-              xSemaphoreGive(xFATSemaphore);
+              xSemaphoreGive(sdCardSemaphore);
               return (false);
             }
           }
@@ -275,17 +279,21 @@ bool loadSystemSettingsFromFileSD(char* fileName, Settings *settings)
 
         //Serial.println(F("Config file read complete"));
         settingsFile.close();
-        xSemaphoreGive(xFATSemaphore);
+        xSemaphoreGive(sdCardSemaphore);
         return (true);
       }
       else
       {
         log_d("File %s not found", fileName);
-        xSemaphoreGive(xFATSemaphore);
+        xSemaphoreGive(sdCardSemaphore);
         return (false);
       }
 
     } //End Semaphore check
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
+    }
   } //End SD online
 
   log_d("Config file read failed: SD offline");

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -141,7 +141,7 @@ SdFile newFirmwareFile; //File that is available if user uploads new firmware vi
 
 //System crashes if two tasks access a file at the same time
 //So we use a semaphore to see if file system is available
-SemaphoreHandle_t xFATSemaphore;
+SemaphoreHandle_t sdCardSemaphore;
 const TickType_t fatSemaphore_shortWait_ms = 10 / portTICK_PERIOD_MS;
 const TickType_t fatSemaphore_longWait_ms = 200 / portTICK_PERIOD_MS;
 
@@ -157,7 +157,7 @@ uint32_t sdUsedSpaceMB = 0;
 #include <WiFi.h> //Built-in.
 #include <HTTPClient.h> //Built-in. Needed for ThingStream API for ZTP
 #include <ArduinoJson.h> //http://librarymanager/All#Arduino_JSON_messagepack v6.19.4
-#include <WiFiClientSecure.h> //Built-in. 
+#include <WiFiClientSecure.h> //Built-in.
 #include <PubSubClient.h> //Built-in. Used for MQTT obtaining of keys
 
 #include "base64.h" //Built-in. Needed for NTRIP Client credential encoding.
@@ -340,7 +340,7 @@ unsigned long lastRockerSwitchChange = 0; //If quick toggle is detected (less th
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 #ifdef COMPILE_WIFI
 #ifdef COMPILE_AP
-#include "ESPAsyncWebServer.h" //Get from: https://github.com/me-no-dev/ESPAsyncWebServer 
+#include "ESPAsyncWebServer.h" //Get from: https://github.com/me-no-dev/ESPAsyncWebServer
 #include "form.h"
 
 AsyncWebServer server(80);
@@ -563,23 +563,31 @@ void updateLogs()
   else if (online.logging == true && settings.enableLogging == false)
   {
     //Close down file
-    if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {
       ubxFile.sync();
       ubxFile.close();
       online.logging = false;
-      xSemaphoreGive(xFATSemaphore); //Release semaphore
+      xSemaphoreGive(sdCardSemaphore); //Release semaphore
+    }
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
     }
   }
   else if (online.logging == true && settings.enableLogging == true && (systemTime_minutes - startCurrentLogTime_minutes) >= settings.maxLogLength_minutes)
   {
     //Close down file. A new one will be created at the next calling of updateLogs().
-    if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {
       ubxFile.sync();
       ubxFile.close();
       online.logging = false;
-      xSemaphoreGive(xFATSemaphore); //Release semaphore
+      xSemaphoreGive(sdCardSemaphore); //Release semaphore
+    }
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
     }
   }
 
@@ -588,7 +596,7 @@ void updateLogs()
     //Force file sync every 5000ms
     if (millis() - lastUBXLogSyncTime > 5000)
     {
-      if (xSemaphoreTake(xFATSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
+      if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
       {
         if (productVariant == RTK_SURVEYOR)
           digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED)); //Blink LED to indicate logging activity
@@ -604,11 +612,11 @@ void updateLogs()
         updateDataFileAccess(&ubxFile); // Update the file access time & date
 
         lastUBXLogSyncTime = millis();
-        xSemaphoreGive(xFATSemaphore);
-      } //End xFATSemaphore
+        xSemaphoreGive(sdCardSemaphore);
+      } //End sdCardSemaphore
       else
       {
-        log_d("Semaphore failed to yield");
+        Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
       }
     }
 
@@ -624,13 +632,17 @@ void updateLogs()
       char nmeaMessage[82]; //Max NMEA sentence length is 82
       createNMEASentence(CUSTOM_NMEA_TYPE_EVENT, nmeaMessage, eventData); //textID, buffer, text
 
-      if (xSemaphoreTake(xFATSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
+      if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
       {
         ubxFile.println(nmeaMessage);
 
-        xSemaphoreGive(xFATSemaphore);
+        xSemaphoreGive(sdCardSemaphore);
         newEventToRecord = false;
       }
+      else
+      {
+        Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
+      }
     }
 
     //Report file sizes to show recording is working
@@ -639,11 +651,15 @@ void updateLogs()
       long fileSize = 0;
 
       //Attempt to access file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile() and F9PSerialReadTask()
-      if (xSemaphoreTake(xFATSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
+      if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
       {
         fileSize = ubxFile.fileSize();
 
-        xSemaphoreGive(xFATSemaphore);
+        xSemaphoreGive(sdCardSemaphore);
+      }
+      else
+      {
+        Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
       }
 
       if (fileSize > 0)

Firmware/RTK_Surveyor/System.ino

@@ -556,25 +556,29 @@ bool createTestFile()
   SdFile testFile;
   char testFileName[40] = "testfile.txt";
 
-  if (xFATSemaphore == NULL)
+  if (sdCardSemaphore == NULL)
   {
-    log_d("xFATSemaphore is Null");
+    log_d("sdCardSemaphore is Null");
     return (false);
   }
 
   //Attempt to write to file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile() and F9PSerialReadTask()
-  if (xSemaphoreTake(xFATSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
+  if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
   {
     if (testFile.open(testFileName, O_CREAT | O_APPEND | O_WRITE) == true)
     {
       testFile.close();
 
       if (sd.exists(testFileName))
         sd.remove(testFileName);
-      xSemaphoreGive(xFATSemaphore);
+      xSemaphoreGive(sdCardSemaphore);
       return (true);
     }
-    xSemaphoreGive(xFATSemaphore);
+    xSemaphoreGive(sdCardSemaphore);
+  }
+  else
+  {
+    Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
   }
 
   return (false);

Firmware/RTK_Surveyor/Tasks.ino

@@ -75,15 +75,15 @@ void F9PSerialReadTask(void *e)
         if ((systemTime_minutes - startLogTime_minutes) < settings.maxLogTime_minutes)
         {
           //Attempt to write to file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile()
-          if (xSemaphoreTake(xFATSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
+          if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
           {
             ubxFile.write(rBuffer, s);
 
-            xSemaphoreGive(xFATSemaphore);
-          } //End xFATSemaphore
+            xSemaphoreGive(sdCardSemaphore);
+          } //End sdCardSemaphore
           else
           {
-            log_d("Semaphore failed to yield");
+            Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
           }
         } //End maxLogTime
       } //End logging

Firmware/RTK_Surveyor/menuFirmware.ino

@@ -52,7 +52,7 @@ void scanForFirmware()
   {
     //Attempt to access file system. This avoids collisions with file writing in F9PSerialReadTask()
     //Wait up to 5s, this is important
-    if (xSemaphoreTake(xFATSemaphore, 5000 / portTICK_PERIOD_MS) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, 5000 / portTICK_PERIOD_MS) == pdPASS)
     {
       //Count available binaries
       SdFile tempFile;
@@ -92,9 +92,12 @@ void scanForFirmware()
         tempFile.close();
       }
 
-      xSemaphoreGive(xFATSemaphore);
+      xSemaphoreGive(sdCardSemaphore);
+    }
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
     }
-
   }
 }
 

Firmware/RTK_Surveyor/menuMain.ino

@@ -219,12 +219,16 @@ void factoryReset()
   //Attempt to write to file system. This avoids collisions with file writing from other functions like recordSystemSettingsToFile() and F9PSerialReadTask()
   if (settings.enableSD && online.microSD)
   {
-    if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {
       //Remove this specific settings file. Don't remove the other profiles.
       sd.remove(settingsFileName);
-      xSemaphoreGive(xFATSemaphore);
-    } //End xFATSemaphore
+      xSemaphoreGive(sdCardSemaphore);
+    } //End sdCardSemaphore
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
+    }
   }
 
   if (online.gnss == true)

Firmware/RTK_Surveyor/menuMessages.ino

@@ -345,7 +345,7 @@ void beginLogging()
       }
 
       //Attempt to write to file system. This avoids collisions with file writing in F9PSerialReadTask()
-      if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) == pdPASS)
+      if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
       {
         // O_CREAT - create the file if it does not exist
         // O_APPEND - seek to the end of the file prior to each write
@@ -354,7 +354,7 @@ void beginLogging()
         {
           Serial.printf("Failed to create GNSS UBX data file: %s\n\r", fileName);
           online.logging = false;
-          xSemaphoreGive(xFATSemaphore);
+          xSemaphoreGive(sdCardSemaphore);
           return;
         }
 
@@ -405,7 +405,7 @@ void beginLogging()
           Serial.println(F("Appending last available log"));
         }
 
-        xSemaphoreGive(xFATSemaphore);
+        xSemaphoreGive(sdCardSemaphore);
       }
       else
       {
@@ -448,7 +448,7 @@ bool findLastLog(char *lastLogName)
   {
     //Attempt to access file system. This avoids collisions with file writing in F9PSerialReadTask()
     //Wait up to 5s, this is important
-    if (xSemaphoreTake(xFATSemaphore, 5000 / portTICK_PERIOD_MS) == pdPASS)
+    if (xSemaphoreTake(sdCardSemaphore, 5000 / portTICK_PERIOD_MS) == pdPASS)
     {
       //Count available binaries
       SdFile tempFile;
@@ -478,7 +478,11 @@ bool findLastLog(char *lastLogName)
         tempFile.close();
       }
 
-      xSemaphoreGive(xFATSemaphore);
+      xSemaphoreGive(sdCardSemaphore);
+    }
+    else
+    {
+      Serial.printf("sdCardSemaphore failed to yield, %s line %d\r\n", __FILE__, __LINE__);
     }
   }