hal/src/fsfw_hal/linux/i2c/I2cComIF.cpp

@@ -1,4 +1,5 @@
 #include "I2cComIF.h"
+
 #include "fsfw/FSFW.h"
 #include "fsfw/serviceinterface.h"
 #include "fsfw_hal/linux/UnixFileGuard.h"
@@ -16,7 +17,6 @@
 
 #include <cstring>
 
-
 I2cComIF::I2cComIF(object_id_t objectId) : SystemObject(objectId) {}
 
 I2cComIF::~I2cComIF() {}

hal/src/fsfw_hal/linux/uart/UartComIF.cpp

@@ -1,7 +1,4 @@
 #include "UartComIF.h"
-#include "fsfw/FSFW.h"
-#include "fsfw/serviceinterface.h"
-#include "fsfw_hal/linux/utility.h"
 
 #include <errno.h>
 #include <fcntl.h>
@@ -10,6 +7,10 @@
 
 #include <cstring>
 
+#include "fsfw/FSFW.h"
+#include "fsfw/serviceinterface.h"
+#include "fsfw_hal/linux/utility.h"
+
 UartComIF::UartComIF(object_id_t objectId) : SystemObject(objectId) {}
 
 UartComIF::~UartComIF() {}

hal/src/fsfw_hal/linux/uio/UioMapper.cpp

@@ -69,8 +69,8 @@ ReturnValue_t UioMapper::getMapSize(size_t* size) {
   }
   uint32_t sizeTmp = 0;
   items = sscanf(hexstring, "%x", &sizeTmp);
-  if(size != nullptr) {
+  if (size != nullptr) {
-      *size = sizeTmp;
+    *size = sizeTmp;
   }
   if (items != 1) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1

src/fsfw/globalfunctions/CRC.cpp

@@ -117,7 +117,7 @@ uint16_t CRC::crc16ccitt(uint8_t const input[], uint32_t length, uint16_t starti
   //	{
   //		 if  (xor_out[i] == true)
   //			 crc_value = crc_value + pow(2,(15 -i));   // reverse CrC result before
-  //Final XOR
+  // Final XOR
   //	}
   //
   //	crc_value = 0;// for debug mode

src/fsfw/health/HasHealthIF.h

@@ -23,19 +23,15 @@ class HasHealthIF {
   static const Event HEALTH_INFO = MAKE_EVENT(6, severity::INFO);
   static const Event CHILD_CHANGED_HEALTH = MAKE_EVENT(7, severity::INFO);
   static const Event CHILD_PROBLEMS = MAKE_EVENT(8, severity::LOW);
-  static const Event OVERWRITING_HEALTH =
+  //! Assembly overwrites health information of children to keep satellite alive.
-      MAKE_EVENT(9, severity::LOW);  //!< Assembly overwrites health information of children to keep
+  static const Event OVERWRITING_HEALTH = MAKE_EVENT(9, severity::LOW);
-                                     //!< satellite alive.
+  //! Someone starts a recovery of a component (typically power-cycle). No parameters.
-  static const Event TRYING_RECOVERY =
+  static const Event TRYING_RECOVERY = MAKE_EVENT(10, severity::MEDIUM);
-      MAKE_EVENT(10, severity::MEDIUM);  //!< Someone starts a recovery of a component (typically
+  //! Recovery is ongoing. Comes twice during recovery.
-                                         //!< power-cycle). No parameters.
+  //! P1: 0 for the first, 1 for the second event. P2: 0
-  static const Event RECOVERY_STEP =
+  static const Event RECOVERY_STEP = MAKE_EVENT(11, severity::MEDIUM);
-      MAKE_EVENT(11, severity::MEDIUM);  //!< Recovery is ongoing. Comes twice during recovery. P1:
+  //! Recovery was completed. Not necessarily successful. No parameters.
-                                         //!< 0 for the first, 1 for the second event. P2: 0
+  static const Event RECOVERY_DONE = MAKE_EVENT(12, severity::MEDIUM);
-  static const Event RECOVERY_DONE = MAKE_EVENT(
-      12,
-      severity::MEDIUM);  //!< Recovery was completed. Not necessarily successful. No parameters.
-
   virtual ~HasHealthIF() {}
 
   virtual MessageQueueId_t getCommandQueue() const = 0;

src/fsfw/modes/HasModesIF.h

@@ -19,32 +19,29 @@ class HasModesIF {
   static const ReturnValue_t INVALID_SUBMODE = MAKE_RETURN_CODE(0x04);
 
   static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::SYSTEM_MANAGER;
-  static const Event CHANGING_MODE =
+  //! An object announces changing the mode. p1: target mode. p2: target submode
-      MAKE_EVENT(0, severity::INFO);  //!< An object announces changing the mode. p1: target mode.
+  static const Event CHANGING_MODE = MAKE_EVENT(0, severity::INFO);
-                                      //!< p2: target submode
+  //! An Object announces its mode; parameter1 is mode, parameter2 is submode
-  static const Event MODE_INFO = MAKE_EVENT(
+  static const Event MODE_INFO = MAKE_EVENT(1, severity::INFO);
-      1,
-      severity::INFO);  //!< An Object announces its mode; parameter1 is mode, parameter2 is submode
   static const Event FALLBACK_FAILED = MAKE_EVENT(2, severity::HIGH);
   static const Event MODE_TRANSITION_FAILED = MAKE_EVENT(3, severity::LOW);
   static const Event CANT_KEEP_MODE = MAKE_EVENT(4, severity::HIGH);
-  static const Event OBJECT_IN_INVALID_MODE =
+  //! Indicates a bug or configuration failure: Object is in a mode it should never be in.
-      MAKE_EVENT(5, severity::LOW);  //!< Indicates a bug or configuration failure: Object is in a
+  static const Event OBJECT_IN_INVALID_MODE = MAKE_EVENT(5, severity::LOW);
-                                     //!< mode it should never be in.
+  //! The mode is changed, but for some reason, the change is forced, i.e. EXTERNAL_CONTROL ignored.
-  static const Event FORCING_MODE = MAKE_EVENT(
+  //! p1: target mode. p2: target submode
-      6, severity::MEDIUM);  //!< The mode is changed, but for some reason, the change is forced,
+  static const Event FORCING_MODE = MAKE_EVENT(6, severity::MEDIUM);
-                             //!< i.e. EXTERNAL_CONTROL ignored. p1: target mode. p2: target submode
+  //! A mode command was rejected by the called object. Par1: called object id, Par2: return code.
-  static const Event MODE_CMD_REJECTED =
+  static const Event MODE_CMD_REJECTED = MAKE_EVENT(7, severity::LOW);
-      MAKE_EVENT(7, severity::LOW);  //!< A mode command was rejected by the called object. Par1:
-                                     //!< called object id, Par2: return code.
 
-  static const Mode_t MODE_ON =
+  //! The device is powered and ready to perform operations. In this mode, no commands are
-      1;  //!< The device is powered and ready to perform operations. In this mode, no commands are
+  //! sent by the device handler itself, but direct commands van be commanded and will be
-          //!< sent by the device handler itself, but direct commands van be commanded and will be
+  //! interpreted
-          //!< interpreted
+  static const Mode_t MODE_ON = 1;
-  static const Mode_t MODE_OFF = 0;  //!< The device is powered off. The only command accepted in
+  //! The device is powered off. The only command accepted in this mode is a mode change to on.
-                                     //!< this mode is a mode change to on.
+  static const Mode_t MODE_OFF = 0;
-  static const Submode_t SUBMODE_NONE = 0;  //!< To avoid checks against magic number "0".
+  //! To avoid checks against magic number "0".
+  static const Submode_t SUBMODE_NONE = 0;
 
   virtual ~HasModesIF() {}
   virtual MessageQueueId_t getCommandQueue() const = 0;

src/fsfw/osal/linux/PeriodicPosixTask.h

@@ -65,9 +65,10 @@ class PeriodicPosixTask : public PosixThread, public PeriodicTaskIF {
   /**
    * @brief	The function containing the actual functionality of the task.
    * @details	The method sets and starts
-   * 			the task's period, then enters a loop that is repeated indefinitely. Within the
+   * 			the task's period, then enters a loop that is repeated indefinitely. Within
-   * loop, all performOperation methods of the added objects are called. Afterwards the task will be
+   * the loop, all performOperation methods of the added objects are called. Afterwards the task
-   * blocked until the next period. On missing the deadline, the deadlineMissedFunction is executed.
+   * will be blocked until the next period. On missing the deadline, the deadlineMissedFunction is
+   * executed.
    */
   virtual void taskFunctionality(void);
   /**

src/fsfw/osal/rtems/PeriodicTask.h

@@ -13,8 +13,8 @@ class ExecutableObjectIF;
  * @brief This class represents a specialized task for periodic activities of multiple objects.
  *
  * @details MultiObjectTask is an extension to ObjectTask in the way that it is able to execute
- * 			multiple objects that implement the ExecutableObjectIF interface. The objects
+ * 			multiple objects that implement the ExecutableObjectIF interface. The
- * must be added prior to starting the task.
+ * objects must be added prior to starting the task.
  * @author  baetz
  * @ingroup task_handling
  */

src/fsfw/power/Fuse.h

@@ -34,14 +34,14 @@ class Fuse : public SystemObject,
   };
 
   static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::PCDU_1;
-  static const Event FUSE_CURRENT_HIGH = MAKE_EVENT(
+  //! PSS detected that current on a fuse is totally out of bounds.
-      1, severity::LOW);  //!< PSS detected that current on a fuse is totally out of bounds.
+  static const Event FUSE_CURRENT_HIGH = MAKE_EVENT(1, severity::LOW);
-  static const Event FUSE_WENT_OFF =
+  //! PSS detected a fuse that went off.
-      MAKE_EVENT(2, severity::LOW);  //!< PSS detected a fuse that went off.
+  static const Event FUSE_WENT_OFF = MAKE_EVENT(2, severity::LOW);
-  static const Event POWER_ABOVE_HIGH_LIMIT =
+  //! PSS detected a fuse that violates its limits.
-      MAKE_EVENT(4, severity::LOW);  //!< PSS detected a fuse that violates its limits.
+  static const Event POWER_ABOVE_HIGH_LIMIT = MAKE_EVENT(4, severity::LOW);
-  static const Event POWER_BELOW_LOW_LIMIT =
+  //! PSS detected a fuse that violates its limits.
-      MAKE_EVENT(5, severity::LOW);  //!< PSS detected a fuse that violates its limits.
+  static const Event POWER_BELOW_LOW_LIMIT = MAKE_EVENT(5, severity::LOW);
 
   typedef std::list<PowerComponentIF *> DeviceList;
   Fuse(object_id_t fuseObjectId, uint8_t fuseId, sid_t variableSet, VariableIds ids,

src/fsfw/rmap/RMAP.h

@@ -169,8 +169,8 @@ class RMAP : public HasReturnvaluesIF {
    * @param buffer the data to write
    * @param length length of data
    * @return
-   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == NULL in
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was ==
-   * write command
+   * NULL in write command
    *      - return codes of RMAPChannelIF::sendCommand()
    */
   static ReturnValue_t sendWriteCommand(RMAPCookie *cookie, const uint8_t *buffer, size_t length);
@@ -205,8 +205,8 @@ class RMAP : public HasReturnvaluesIF {
    * @param cookie to cookie to read from
    * @param expLength the expected maximum length of the reply
    * @return
-   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == NULL in
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was ==
-   * write command, or nullpointer in read command
+   * NULL in write command, or nullpointer in read command
    *      - return codes of RMAPChannelIF::sendCommand()
    */
   static ReturnValue_t sendReadCommand(RMAPCookie *cookie, uint32_t expLength);

src/fsfw/rmap/RMAPChannelIF.h

@@ -75,10 +75,10 @@ class RMAPChannelIF {
    *      - @c RETURN_OK
    *      - @c COMMAND_NO_DESCRIPTORS_AVAILABLE 	no descriptors available for sending
    * command; command was not sent
-   *      - @c COMMAND_BUFFER_FULL				no receiver buffer available for expected len;
+   *      - @c COMMAND_BUFFER_FULL				no receiver buffer available for
-   * command was not sent
+   * expected len; command was not sent
-   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too long for the hw
+   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too long for
-   * to handle (write command) or the expected len was bigger than maximal expected len (read
+   * the hw to handle (write command) or the expected len was bigger than maximal expected len (read
    * command) command was not sent
    *      - @c COMMAND_CHANNEL_DEACTIVATED		the channel has no port set
    *      - @c NOT_SUPPORTED						if you dont feel like
@@ -97,8 +97,8 @@ class RMAPChannelIF {
    *      - @c REPLY_NO_REPLY				no reply was received
    *      - @c REPLY_NOT_SENT				command was not sent, implies no reply
    *      - @c REPLY_NOT_YET_SENT			command is still waiting to be sent
-   *      - @c WRITE_REPLY_INTERFACE_BUSY			Interface is busy (transmission buffer still
+   *      - @c WRITE_REPLY_INTERFACE_BUSY			Interface is busy (transmission
-   * being processed)
+   * buffer still being processed)
    *      - @c WRITE_REPLY_TRANSMISSION_ERROR		Interface encountered errors during last
    * operation, data could not be processed. (transmission error)
    *      - @c WRITE_REPLY_INVALID_DATA			Invalid data (amount / value)

src/fsfw/tmstorage/TmStoreBackendIF.h

@@ -33,50 +33,47 @@ class TmStoreBackendIF : public HasParametersIF {
   static const ReturnValue_t INVALID_REQUEST = MAKE_RETURN_CODE(15);
 
   static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::MEMORY;
-  static const Event STORE_SEND_WRITE_FAILED =
+  //! Initiating sending data to store failed. Low, par1:
-      MAKE_EVENT(0, severity::LOW);  //!< Initiating sending data to store failed. Low, par1:
+  //! returnCode, par2: integer (debug info)
-                                     //!< returnCode, par2: integer (debug info)
+  static const Event STORE_SEND_WRITE_FAILED = MAKE_EVENT(0, severity::LOW);
-  static const Event STORE_WRITE_FAILED = MAKE_EVENT(
+  //! Data was sent, but writing failed. Low, par1: returnCode, par2: 0
-      1, severity::LOW);  //!< Data was sent, but writing failed. Low, par1: returnCode, par2: 0
+  static const Event STORE_WRITE_FAILED = MAKE_EVENT(1, severity::LOW);
-  static const Event STORE_SEND_READ_FAILED =
+  //! Initiating reading data from store failed. Low, par1: returnCode, par2: 0
-      MAKE_EVENT(2, severity::LOW);  //!< Initiating reading data from store failed. Low, par1:
+  static const Event STORE_SEND_READ_FAILED = MAKE_EVENT(2, severity::LOW);
-                                     //!< returnCode, par2: 0
+  //! Data was requested, but access failed. Low, par1: returnCode, par2: 0
-  static const Event STORE_READ_FAILED = MAKE_EVENT(
+  static const Event STORE_READ_FAILED = MAKE_EVENT(3, severity::LOW);
-      3, severity::LOW);  //!< Data was requested, but access failed. Low, par1: returnCode, par2: 0
+  //! An unexpected TM packet or data message occurred. Low, par1: 0, par2: integer (debug info)
-  static const Event UNEXPECTED_MSG =
+  static const Event UNEXPECTED_MSG = MAKE_EVENT(4, severity::LOW);
-      MAKE_EVENT(4, severity::LOW);  //!< An unexpected TM packet or data message occurred. Low,
+  //! Storing data failed. May simply be a full store. Low, par1: returnCode,
-                                     //!< par1: 0, par2: integer (debug info)
+  //! par2: integer (sequence count of failed packet).
-  static const Event STORING_FAILED = MAKE_EVENT(
+  static const Event STORING_FAILED = MAKE_EVENT(5, severity::LOW);
-      5, severity::LOW);  //!< Storing data failed. May simply be a full store. Low, par1:
+  //! Dumping retrieved data failed. Low, par1: returnCode,
-                          //!< returnCode, par2: integer (sequence count of failed packet).
+  //! par2: integer (sequence count of failed packet).
-  static const Event TM_DUMP_FAILED =
+  static const Event TM_DUMP_FAILED = MAKE_EVENT(6, severity::LOW);
-      MAKE_EVENT(6, severity::LOW);  //!< Dumping retrieved data failed. Low, par1: returnCode,
+  //! Corrupted init data or read error. Low, par1: returnCode, par2: integer (debug info)
-                                     //!< par2: integer (sequence count of failed packet).
+  //! Store was not initialized. Starts empty. Info, parameters both zero.
-  static const Event STORE_INIT_FAILED =
+  static const Event STORE_INIT_FAILED = MAKE_EVENT(7, severity::LOW);
-      MAKE_EVENT(7, severity::LOW);  //!< Corrupted init data or read error. Low, par1: returnCode,
+  //! Data was read out, but it is inconsistent. Low par1:
-                                     //!< par2: integer (debug info)
+  //! Memory address of corruption, par2: integer (debug info)
-  static const Event STORE_INIT_EMPTY = MAKE_EVENT(
+  static const Event STORE_INIT_EMPTY = MAKE_EVENT(8, severity::INFO);
-      8, severity::INFO);  //!< Store was not initialized. Starts empty. Info, parameters both zero.
+
-  static const Event STORE_CONTENT_CORRUPTED =
+  static const Event STORE_CONTENT_CORRUPTED = MAKE_EVENT(9, severity::LOW);
-      MAKE_EVENT(9, severity::LOW);  //!< Data was read out, but it is inconsistent. Low par1:
+  //! Info event indicating the store will be initialized, either at boot or after IOB switch.
-                                     //!< Memory address of corruption, par2: integer (debug info)
+  //! Info. pars: 0
-  static const Event STORE_INITIALIZE =
+  static const Event STORE_INITIALIZE = MAKE_EVENT(10, severity::INFO);
-      MAKE_EVENT(10, severity::INFO);  //!< Info event indicating the store will be initialized,
+  //! Info event indicating the store was successfully initialized, either at boot or after
-                                       //!< either at boot or after IOB switch. Info. pars: 0
+  //! IOB switch. Info. pars: 0
-  static const Event INIT_DONE = MAKE_EVENT(
+  static const Event INIT_DONE = MAKE_EVENT(11, severity::INFO);
-      11, severity::INFO);  //!< Info event indicating the store was successfully initialized,
+  //! Info event indicating that dumping finished successfully.
-                            //!< either at boot or after IOB switch. Info. pars: 0
+  //! par1: Number of dumped packets. par2: APID/SSC (16bits each)
-  static const Event DUMP_FINISHED = MAKE_EVENT(
+  static const Event DUMP_FINISHED = MAKE_EVENT(12, severity::INFO);
-      12, severity::INFO);  //!< Info event indicating that dumping finished successfully. par1:
+  //! Info event indicating that deletion finished successfully.
-                            //!< Number of dumped packets. par2: APID/SSC (16bits each)
+  //! par1:Number of deleted packets. par2: APID/SSC (16bits each)
-  static const Event DELETION_FINISHED = MAKE_EVENT(
+  static const Event DELETION_FINISHED = MAKE_EVENT(13, severity::INFO);
-      13, severity::INFO);  //!< Info event indicating that deletion finished successfully. par1:
+  //! Info event indicating that something went wrong during deletion. pars: 0
-                            //!< Number of deleted packets. par2: APID/SSC (16bits each)
+  static const Event DELETION_FAILED = MAKE_EVENT(14, severity::LOW);
-  static const Event DELETION_FAILED = MAKE_EVENT(
+  //! Info that the a auto catalog report failed
-      14,
+  static const Event AUTO_CATALOGS_SENDING_FAILED = MAKE_EVENT(15, severity::INFO);
-      severity::LOW);  //!< Info event indicating that something went wrong during deletion. pars: 0
-  static const Event AUTO_CATALOGS_SENDING_FAILED =
-      MAKE_EVENT(15, severity::INFO);  //!< Info that the a auto catalog report failed
 
   virtual ~TmStoreBackendIF() {}