used ChatGPT to add comments and proper Headers to all SourceFiles

Software/src/dtc.cpp

@@ -1,14 +1,37 @@
+/**
+ * @file dtc.cpp
+ * @brief Implementation of functions related to Diagnostic Trouble Codes (DTCs).
+ *
+ * This file contains the implementation of functions that manage the status
+ * and registration of Diagnostic Trouble Codes in the system.
+ *
+ * @author Marcel Peterkau
+ * @date 09.01.2024
+ */
 #include "dtc.h"
 #include "debugger.h"
 
 DTCEntry_t DTCStorage[MAX_DTC_STORAGE];
 
+// Function implementations...
+
+/**
+ * @brief Maintains the status of Diagnostic Trouble Codes (DTCs) in the DTCStorage array.
+ *        Updates the status of existing DTCs or adds new ones based on their activity.
+ *
+ * @param DTC_no      The number of the Diagnostic Trouble Code.
+ * @param active      Indicates whether the DTC is active (true) or inactive (false).
+ * @param DebugValue  Additional debugging information associated with the DTC.
+ */
 void MaintainDTC(DTCNum_t DTC_no, boolean active, uint32_t DebugValue)
 {
+    // Iterate through the existing DTCs in the storage
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
     {
+        // Check if the DTC with the specified number exists
         if (DTCStorage[i].Number == DTC_no)
         {
+            // If the DTC is active and was not active before, update its status
             if (active && DTCStorage[i].active != DTC_ACTIVE)
             {
                 Debug_pushMessage("DTC gone active: %d, DebugVal: %d\n", DTC_no, DebugValue);
@@ -16,21 +39,23 @@ void MaintainDTC(DTCNum_t DTC_no, boolean active, uint32_t DebugValue)
                 DTCStorage[i].active = DTC_ACTIVE;
                 DTCStorage[i].debugVal = DebugValue;
             }
+            // If the DTC is not active anymore, update its status to previous
             if (!active && DTCStorage[i].active == DTC_ACTIVE)
             {
                 Debug_pushMessage("DTC gone previous: %d\n", DTC_no);
                 DTCStorage[i].active = DTC_PREVIOUS;
             }
-            return;
+            return; // DTC found and processed, exit the function
         }
     }
 
-    // DTC was not found with upper iteration, but is active
-    // so we need to look for free space to store DTC
+    // DTC was not found in the existing storage, but it is active,
+    // so look for free space to store the new DTC
     if (active == true)
     {
         for (int i = 0; i < MAX_DTC_STORAGE; i++)
         {
+            // Check for an empty slot in the storage
             if (DTCStorage[i].Number == DTC_LAST_DTC)
             {
                 Debug_pushMessage("new DTC registered: %d, DebugVal: %d\n", DTC_no, DebugValue);
@@ -38,12 +63,20 @@ void MaintainDTC(DTCNum_t DTC_no, boolean active, uint32_t DebugValue)
                 DTCStorage[i].timestamp = millis();
                 DTCStorage[i].active = DTC_ACTIVE;
                 DTCStorage[i].debugVal = DebugValue;
-                return;
+                return; // New DTC registered, exit the function
             }
         }
     }
 }
 
+/**
+ * @brief Clears a specific Diagnostic Trouble Code (DTC) entry.
+ *
+ * This function clears the information related to a specific DTC entry,
+ * setting its status to inactive and timestamp to zero.
+ *
+ * @param DTC_no The Diagnostic Trouble Code number to be cleared.
+ */
 void ClearDTC(DTCNum_t DTC_no)
 {
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
@@ -57,6 +90,12 @@ void ClearDTC(DTCNum_t DTC_no)
     }
 }
 
+/**
+ * @brief Clears all Diagnostic Trouble Code (DTC) entries.
+ *
+ * This function clears all DTC entries, setting their status to inactive and
+ * timestamps to zero.
+ */
 void ClearAllDTC()
 {
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
@@ -67,6 +106,15 @@ void ClearAllDTC()
     }
 }
 
+/**
+ * @brief Gets the last recorded Diagnostic Trouble Code (DTC) number.
+ *
+ * This function retrieves the DTC number of the last recorded DTC based on the
+ * timestamp. Optionally, it can filter only active DTCs.
+ *
+ * @param only_active If true, considers only active DTCs; otherwise, considers all.
+ * @return The DTC number of the last recorded DTC or DTC_LAST_DTC if none found.
+ */
 DTCNum_t getlastDTC(boolean only_active)
 {
     int8_t pointer = -1;
@@ -87,6 +135,15 @@ DTCNum_t getlastDTC(boolean only_active)
     return pointer >= 0 ? DTCStorage[pointer].Number : DTC_LAST_DTC;
 }
 
+/**
+ * @brief Gets the severity level for a specific Diagnostic Trouble Code (DTC).
+ *
+ * This function looks up the severity level associated with the provided DTC code
+ * from the predefined list of DTC definitions.
+ *
+ * @param targetCode The DTC code for which to retrieve the severity.
+ * @return The severity level of the specified DTC or DTC_NONE if not found.
+ */
 DTCSeverity_t getSeverityForDTC(DTCNum_t targetCode)
 {
     for (int i = 0; i < DTC_LAST_DTC; i++)
@@ -99,6 +156,16 @@ DTCSeverity_t getSeverityForDTC(DTCNum_t targetCode)
     return DTC_NONE;
 }
 
+/**
+ * @brief Processes Diagnostic Trouble Codes (DTCs) and updates system status accordingly.
+ *
+ * This function checks for the presence of active DTCs and adjusts the system status
+ * based on the severity of the most critical DTC. If a critical DTC is detected,
+ * the system status is set to sysStat_Error, potentially triggering a system shutdown.
+ *
+ * @note The function also preserves the original system status when transitioning to an error state
+ *       and restores it when all DTCs are cleared.
+ */
 void DTC_Process()
 {
     static tSystem_Status preserverSysStatusError;
@@ -120,10 +187,10 @@ void DTC_Process()
     else
     {
         globals.hasDTC = false;
-        
+
         if (globals.systemStatus == sysStat_Error)
         {
             globals.systemStatus = preserverSysStatusError;
         }
     }
-}
+}