Merge branch 'mueller/gpio-hal-updates' into mueller/master

Reviewed-on: fsfw/fsfw#564

CHANGELOG.md

@@ -8,6 +8,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v5.0.0]
+
+## Changes
+
+- GPIO HAL: Renamed entries of enumerations to avoid nameclashes with Windows defines.
+  `IN` and `OUT` in `Direction` changed to `DIR_IN` and `DIR_OUT`.
+  `CALLBACK` in `GpioTypes` changed to `TYPE_CALLBACK`
+
+## Removed
+
+- Removed the `HkSwitchHelper`. This module should not be needed anymore, now that the local
+  datapools have been implemented
+
+## Additions
+
+- Linux HAL: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1
+
 # [v4.0.0]
 
 ## Additions

README.md

@@ -71,9 +71,9 @@ add and link against the FSFW library in general.
 
 4. Link against the FSFW library
 
-	```cmake
-	target_link_libraries(<YourProjectName> PRIVATE fsfw)
-	```
+   ```cmake
+   target_link_libraries(${YourProjectName} PRIVATE fsfw)
+   ```
 
 5. It should now be possible use the FSFW as a static library from the user code.
 

hal/src/fsfw_hal/common/gpio/gpioDefinitions.h

@@ -9,18 +9,18 @@ using gpioId_t = uint16_t;
 
 namespace gpio {
 
-enum Levels : uint8_t { LOW = 0, HIGH = 1, NONE = 99 };
+enum class Levels : int { LOW = 0, HIGH = 1, NONE = 99 };
 
-enum Direction : uint8_t { DIR_IN = 0, DIR_OUT = 1 };
+enum class Direction : int { IN = 0, OUT = 1 };
 
-enum GpioOperation { READ, WRITE };
+enum class GpioOperation { READ, WRITE };
 
 enum class GpioTypes {
   NONE,
   GPIO_REGULAR_BY_CHIP,
   GPIO_REGULAR_BY_LABEL,
   GPIO_REGULAR_BY_LINE_NAME,
-  TYPE_CALLBACK
+  CALLBACK
 };
 
 static constexpr gpioId_t NO_GPIO = -1;
@@ -57,7 +57,7 @@ class GpioBase {
   // Can be used to cast GpioBase to a concrete child implementation
   gpio::GpioTypes gpioType = gpio::GpioTypes::NONE;
   std::string consumer;
-  gpio::Direction direction = gpio::Direction::DIR_IN;
+  gpio::Direction direction = gpio::Direction::IN;
   gpio::Levels initValue = gpio::Levels::NONE;
 };
 
@@ -80,7 +80,7 @@ class GpiodRegularByChip : public GpiodRegularBase {
  public:
   GpiodRegularByChip()
       : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, std::string(),
-                         gpio::Direction::DIR_IN, gpio::LOW, 0) {}
+                         gpio::Direction::IN, gpio::Levels::LOW, 0) {}
 
   GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_,
                      gpio::Direction direction_, gpio::Levels initValue_)
@@ -89,8 +89,8 @@ class GpiodRegularByChip : public GpiodRegularBase {
         chipname(chipname_) {}
 
   GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_)
-      : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, consumer_, gpio::Direction::DIR_IN,
-                         gpio::LOW, lineNum_),
+      : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, consumer_, gpio::Direction::IN,
+                         gpio::Levels::LOW, lineNum_),
         chipname(chipname_) {}
 
   std::string chipname;
@@ -105,8 +105,8 @@ class GpiodRegularByLabel : public GpiodRegularBase {
         label(label_) {}
 
   GpiodRegularByLabel(std::string label_, int lineNum_, std::string consumer_)
-      : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_, gpio::Direction::DIR_IN,
-                         gpio::LOW, lineNum_),
+      : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_, gpio::Direction::IN,
+                         gpio::Levels::LOW, lineNum_),
         label(label_) {}
 
   std::string label;
@@ -127,7 +127,7 @@ class GpiodRegularByLineName : public GpiodRegularBase {
 
   GpiodRegularByLineName(std::string lineName_, std::string consumer_)
       : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME, consumer_,
-                         gpio::Direction::DIR_IN, gpio::LOW),
+                         gpio::Direction::IN, gpio::Levels::LOW),
         lineName(lineName_) {}
 
   std::string lineName;
@@ -137,7 +137,7 @@ class GpioCallback : public GpioBase {
  public:
   GpioCallback(std::string consumer, gpio::Direction direction_, gpio::Levels initValue_,
                gpio::gpio_cb_t callback, void* callbackArgs)
-      : GpioBase(gpio::GpioTypes::TYPE_CALLBACK, consumer, direction_, initValue_),
+      : GpioBase(gpio::GpioTypes::CALLBACK, consumer, direction_, initValue_),
         callback(callback),
         callbackArgs(callbackArgs) {}
 

hal/src/fsfw_hal/linux/gpio/LinuxLibgpioIF.cpp

@@ -74,7 +74,7 @@ ReturnValue_t LinuxLibgpioIF::configureGpios(GpioMap& mapToAdd) {
         configureGpioByLineName(gpioConfig.first, *regularGpio);
         break;
       }
-      case (gpio::GpioTypes::TYPE_CALLBACK): {
+      case (gpio::GpioTypes::CALLBACK): {
         auto gpioCallback = dynamic_cast<GpioCallback*>(gpioConfig.second);
         if (gpioCallback->callback == nullptr) {
           return GPIO_INVALID_INSTANCE;
@@ -161,11 +161,12 @@ ReturnValue_t LinuxLibgpioIF::configureRegularGpio(gpioId_t gpioId, struct gpiod
   consumer = regularGpio.consumer;
   /* Configure direction and add a description to the GPIO */
   switch (direction) {
-    case (gpio::DIR_OUT): {
-      result = gpiod_line_request_output(lineHandle, consumer.c_str(), regularGpio.initValue);
+    case (gpio::Direction::OUT): {
+      result = gpiod_line_request_output(lineHandle, consumer.c_str(),
+          static_cast<int>(regularGpio.initValue));
       break;
     }
-    case (gpio::DIR_IN): {
+    case (gpio::Direction::IN): {
       result = gpiod_line_request_input(lineHandle, consumer.c_str());
       break;
     }
@@ -211,7 +212,7 @@ ReturnValue_t LinuxLibgpioIF::pullHigh(gpioId_t gpioId) {
     if (regularGpio == nullptr) {
       return GPIO_TYPE_FAILURE;
     }
-    return driveGpio(gpioId, *regularGpio, gpio::HIGH);
+    return driveGpio(gpioId, *regularGpio, gpio::Levels::HIGH);
   } else {
     auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
     if (gpioCallback->callback == nullptr) {
@@ -243,7 +244,7 @@ ReturnValue_t LinuxLibgpioIF::pullLow(gpioId_t gpioId) {
     if (regularGpio == nullptr) {
       return GPIO_TYPE_FAILURE;
     }
-    return driveGpio(gpioId, *regularGpio, gpio::LOW);
+    return driveGpio(gpioId, *regularGpio, gpio::Levels::LOW);
   } else {
     auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
     if (gpioCallback->callback == nullptr) {
@@ -258,11 +259,11 @@ ReturnValue_t LinuxLibgpioIF::pullLow(gpioId_t gpioId) {
 
 ReturnValue_t LinuxLibgpioIF::driveGpio(gpioId_t gpioId, GpiodRegularBase& regularGpio,
                                         gpio::Levels logicLevel) {
-  int result = gpiod_line_set_value(regularGpio.lineHandle, logicLevel);
+  int result = gpiod_line_set_value(regularGpio.lineHandle, static_cast<int>(logicLevel));
   if (result < 0) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1
     sif::warning << "LinuxLibgpioIF::driveGpio: Failed to pull GPIO with ID " << gpioId
-                 << " to logic level " << logicLevel << std::endl;
+                 << " to logic level " << static_cast<int>(logicLevel) << std::endl;
 #else
     sif::printWarning(
         "LinuxLibgpioIF::driveGpio: Failed to pull GPIO with ID %d to "
@@ -326,7 +327,7 @@ ReturnValue_t LinuxLibgpioIF::checkForConflicts(GpioMap& mapToAdd) {
         }
         break;
       }
-      case (gpio::GpioTypes::TYPE_CALLBACK): {
+      case (gpio::GpioTypes::CALLBACK): {
         auto callbackGpio = dynamic_cast<GpioCallback*>(gpioConfig.second);
         if (callbackGpio == nullptr) {
           return GPIO_TYPE_FAILURE;
@@ -366,13 +367,13 @@ ReturnValue_t LinuxLibgpioIF::checkForConflictsById(gpioId_t gpioIdToCheck,
       case (gpio::GpioTypes::GPIO_REGULAR_BY_CHIP):
       case (gpio::GpioTypes::GPIO_REGULAR_BY_LABEL):
       case (gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME): {
-        if (gpioType == gpio::GpioTypes::NONE or gpioType == gpio::GpioTypes::TYPE_CALLBACK) {
+        if (gpioType == gpio::GpioTypes::NONE or gpioType == gpio::GpioTypes::CALLBACK) {
           eraseDuplicateDifferentType = true;
         }
         break;
       }
-      case (gpio::GpioTypes::TYPE_CALLBACK): {
-        if (gpioType != gpio::GpioTypes::TYPE_CALLBACK) {
+      case (gpio::GpioTypes::CALLBACK): {
+        if (gpioType != gpio::GpioTypes::CALLBACK) {
           eraseDuplicateDifferentType = true;
         }
       }

src/fsfw/FSFW.h.in

@@ -62,4 +62,9 @@
 #define FSFW_HAL_I2C_WIRETAPPING            0
 #endif
 
+// Can be used for low-level debugging of the I2C bus
+#ifndef FSFW_HAL_I2C_WIRETAPPING
+#define FSFW_HAL_I2C_WIRETAPPING            0
+#endif
+
 #endif /* FSFW_FSFW_H_ */

src/fsfw/datapool/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${LIB_FSFW_NAME} PRIVATE 
-    PoolDataSetBase.cpp
-    PoolEntry.cpp
+target_sources(${LIB_FSFW_NAME} PRIVATE
+	PoolDataSetBase.cpp
+	PoolEntry.cpp
 )

src/fsfw/devicehandlers/DeviceHandlerBase.cpp

@@ -1386,6 +1386,8 @@ void DeviceHandlerBase::setTaskIF(PeriodicTaskIF* task) { executingTask = task;
 void DeviceHandlerBase::debugInterface(uint8_t positionTracker, object_id_t objectId,
                                        uint32_t parameter) {}
 
+Submode_t DeviceHandlerBase::getInitialSubmode() { return SUBMODE_NONE; }
+
 void DeviceHandlerBase::performOperationHook() {}
 
 ReturnValue_t DeviceHandlerBase::initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
@@ -1408,7 +1410,7 @@ ReturnValue_t DeviceHandlerBase::initializeAfterTaskCreation() {
   this->poolManager.initializeAfterTaskCreation();
 
   if (setStartupImmediately) {
-    startTransition(MODE_ON, SUBMODE_NONE);
+    startTransition(MODE_ON, getInitialSubmode());
   }
   return HasReturnvaluesIF::RETURN_OK;
 }

src/fsfw/devicehandlers/DeviceHandlerBase.h

@@ -647,6 +647,12 @@ class DeviceHandlerBase : public DeviceHandlerIF,
   virtual void debugInterface(uint8_t positionTracker = 0, object_id_t objectId = 0,
                               uint32_t parameter = 0);
 
+  /**
+   * @brief Can be overwritten by a child to specify the initial submode when device has been set
+   *        to startup immediately.
+   */
+  virtual Submode_t getInitialSubmode();
+
  protected:
   static const uint8_t INTERFACE_ID = CLASS_ID::DEVICE_HANDLER_BASE;
 

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 write command
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == 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 write command, or nullpointer in read command
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == 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,11 +75,11 @@ 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; command was not sent
-   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too
-   * long for the hw to handle (write command) or the expected len was bigger than maximal expected
-   * len (read command) command was not sent
+   *      - @c COMMAND_BUFFER_FULL				no receiver buffer available for expected
+   * len; command was not sent
+   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too long for 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
    * implementing something...
@@ -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 being processed)
+   *      - @c WRITE_REPLY_INTERFACE_BUSY			Interface is busy (transmission 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)

tests/src/fsfw_tests/unit/hal/testCommandExecutor.cpp

@@ -73,7 +73,7 @@ TEST_CASE("Command Executor", "[cmd-exec]") {
     REQUIRE(result != CommandExecutor::COMMAND_ERROR);
     // This ensures that the tests do not block indefinitely
     usleep(500);
-    REQUIRE(limitIdx < 500);
+    REQUIRE(limitIdx < 50000);
   }
   limitIdx = 0;
   CHECK(bytesHaveBeenRead == true);