source file for utility now

linux/CMakeLists.txt

@@ -2,5 +2,6 @@ add_subdirectory(gpio)
 add_subdirectory(i2c)
 add_subdirectory(csp)
 add_subdirectory(spi)
+add_subdirectory(utility)
 add_subdirectory(boardtest)
 

linux/i2c/I2cComIF.cpp

@@ -1,12 +1,13 @@
 #include "I2cComIF.h"
 #include <fsfw/serviceinterface/ServiceInterface.h>
-
 #include <unistd.h>
 #include <fcntl.h>
 #include <sys/ioctl.h>
 #include <linux/i2c-dev.h>
 #include <errno.h>
-#include <string.h>
+#include <linux/utility/Utility.h>
+
+#include <cstring>
 
 
 I2cComIF::I2cComIF(object_id_t objectId): SystemObject(objectId){
@@ -68,8 +69,7 @@ ReturnValue_t I2cComIF::sendMessage(CookieIF *cookie,
 
     I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
     if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::sendMessasge: Invalid I2C Cookie!"
+        sif::error << "I2cComIF::sendMessage: Invalid I2C Cookie!" << std::endl;
-                << std::endl;
         return NULLPOINTER;
     }
 
@@ -82,6 +82,10 @@ ReturnValue_t I2cComIF::sendMessage(CookieIF *cookie,
     }
 
     deviceFile = i2cCookie->getDeviceFile();
+    utility::UnixFileHelper fileHelper(deviceFile, &fd, O_RDWR, "I2cComIF::sendMessage");
+    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
+        return fileHelper.getOpenResult();
+    }
     result = openDevice(deviceFile, i2cAddress, &fd);
     if (result != HasReturnvaluesIF::RETURN_OK){
         return result;
@@ -91,10 +95,8 @@ ReturnValue_t I2cComIF::sendMessage(CookieIF *cookie,
         sif::error << "I2cComIF::sendMessage: Failed to send data to I2C "
                 "device with error code " << errno << ". Error description: "
                 << strerror(errno) << std::endl;
-        close(fd);
         return HasReturnvaluesIF::RETURN_FAILED;
     }
-    close(fd);
     return HasReturnvaluesIF::RETURN_OK;
 }
 
@@ -104,7 +106,6 @@ ReturnValue_t I2cComIF::getSendSuccess(CookieIF *cookie) {
 
 ReturnValue_t I2cComIF::requestReceiveMessage(CookieIF *cookie,
         size_t requestLen) {
-
     ReturnValue_t result;
     int fd;
     std::string deviceFile;
@@ -115,8 +116,7 @@ ReturnValue_t I2cComIF::requestReceiveMessage(CookieIF *cookie,
 
     I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
     if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::requestReceiveMessage: Invalid I2C Cookie!"
+        sif::error << "I2cComIF::requestReceiveMessage: Invalid I2C Cookie!" << std::endl;
-                << std::endl;
         i2cDeviceMapIter->second.replyLen = 0;
         return NULLPOINTER;
     }
@@ -131,6 +131,10 @@ ReturnValue_t I2cComIF::requestReceiveMessage(CookieIF *cookie,
     }
 
     deviceFile = i2cCookie->getDeviceFile();
+    utility::UnixFileHelper fileHelper(deviceFile, &fd, O_RDWR, "I2cComIF::requestReceiveMessage");
+    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
+        return fileHelper.getOpenResult();
+    }
     result = openDevice(deviceFile, i2cAddress, &fd);
     if (result != HasReturnvaluesIF::RETURN_OK){
         i2cDeviceMapIter->second.replyLen = 0;
@@ -139,19 +143,15 @@ ReturnValue_t I2cComIF::requestReceiveMessage(CookieIF *cookie,
 
     uint8_t* replyBuffer = i2cDeviceMapIter->second.replyBuffer.data();
 
-    if (read(fd, replyBuffer, requestLen) != (int)requestLen) {
+    if (read(fd, replyBuffer, requestLen) != static_cast<int>(requestLen)) {
         sif::error << "I2cComIF::requestReceiveMessage: Reading from I2C "
                 << "device failed with error code " << errno <<". Description"
                 << " of error: " << strerror(errno) << std::endl;
-        close(fd);
         i2cDeviceMapIter->second.replyLen = 0;
         return HasReturnvaluesIF::RETURN_FAILED;
     }
 
     i2cDeviceMapIter->second.replyLen = requestLen;
-
-    close(fd);
-
     return HasReturnvaluesIF::RETURN_OK;
 }
 
@@ -159,8 +159,7 @@ ReturnValue_t I2cComIF::readReceivedMessage(CookieIF *cookie,
         uint8_t **buffer, size_t* size) {
     I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
     if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::readReceivedMessage: Invalid I2C Cookie!"
+        sif::error << "I2cComIF::readReceivedMessage: Invalid I2C Cookie!" << std::endl;
-                << std::endl;
         return NULLPOINTER;
     }
 
@@ -179,20 +178,6 @@ ReturnValue_t I2cComIF::readReceivedMessage(CookieIF *cookie,
 
 ReturnValue_t I2cComIF::openDevice(std::string deviceFile,
         address_t i2cAddress, int* fileDescriptor) {
-    *fileDescriptor = open(deviceFile.c_str(), O_RDWR);
-    if (*fileDescriptor < 0) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "I2cComIF: Opening I2C device failed with error code " << errno << "." <<
-                std::endl;
-        sif::warning << "Error description: " << strerror(errno) << std::endl;
-#else
-        sif::printWarning("I2cComIF: Opening I2C device failed with error code %d.\n");
-        sif::printWarning("Error description: %s\n", strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
 
     if (ioctl(*fileDescriptor, I2C_SLAVE, i2cAddress) < 0) {
 #if FSFW_VERBOSE_LEVEL >= 1

linux/spi/SpiComIF.cpp

@@ -3,14 +3,14 @@
 
 #include <linux/spi/SpiCookie.h>
 #include <fsfw/ipc/MutexFactory.h>
-
 #include <fcntl.h>
 #include <unistd.h>
 #include <sys/ioctl.h>
 #include <linux/spi/spidev.h>
 #include <errno.h>
 #include <fsfw/ipc/MutexHelper.h>
-#include <linux/utility/utility.h>
+#include <linux/utility/Utility.h>
+
 #include <cstring>
 
 SpiComIF::SpiComIF(object_id_t objectId, GpioIF* gpioComIF): SystemObject(objectId),
@@ -31,7 +31,7 @@ SpiComIF::SpiComIF(object_id_t objectId, GpioIF* gpioComIF): SystemObject(object
 ReturnValue_t SpiComIF::initializeInterface(CookieIF *cookie) {
     SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
     if(spiCookie == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
+        return NULLPOINTER;
     }
 
     address_t spiAddress = spiCookie->getSpiAddress();
@@ -140,7 +140,7 @@ ReturnValue_t SpiComIF::sendMessage(CookieIF *cookie, const uint8_t *sendData, s
     SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
     ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
     if(spiCookie == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
+        return NULLPOINTER;
     }
 
     if(sendLen > spiCookie->getMaxBufferSize()) {
@@ -208,7 +208,7 @@ ReturnValue_t SpiComIF::requestReceiveMessage(CookieIF *cookie, size_t requestLe
     ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
     SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
     if(spiCookie == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
+        return NULLPOINTER;
     }
 
     bool fullDuplex = spiCookie->isFullDuplex();

linux/utility/CMakeLists.txt

@@ -0,0 +1,7 @@
+target_sources(${TARGET_NAME} PUBLIC
+    Utility.cpp
+)
+
+
+
+

linux/utility/Utility.cpp

@@ -0,0 +1,52 @@
+#include "Utility.h"
+
+void utility::handleIoctlError(const char* const customPrintout) {
+#if FSFW_VERBOSE_LEVEL >= 1
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+    if(customPrintout != nullptr) {
+        sif::warning << customPrintout << std::endl;
+    }
+    sif::warning << "handleIoctlError: Error code " << errno << ", "<< strerror(errno) <<
+            std::endl;
+#else
+    if(customPrintout != nullptr) {
+        sif::printWarning("%s\n", customPrintout);
+    }
+    sif::printWarning("handleIoctlError: Error code %d, %s\n", errno, strerror(errno));
+#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
+#endif /* FSFW_VERBOSE_LEVEL >= 1 */
+
+}
+
+utility::UnixFileHelper::UnixFileHelper(std::string device, int* fileDescriptor, int flags,
+        std::string diagnosticPrefix):
+                    fileDescriptor(fileDescriptor) {
+    if(fileDescriptor == nullptr) {
+        return;
+    }
+    *fileDescriptor = open(device.c_str(), flags);
+    if (*fileDescriptor < 0) {
+#if FSFW_VERBOSE_LEVEL >= 1
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+        sif::warning << diagnosticPrefix <<"Opening device failed with error code " << errno <<
+                "." << std::endl;
+        sif::warning << "Error description: " << strerror(errno) << std::endl;
+#else
+        sif::printError("%sOpening device failed with error code %d.\n", diagnosticPrefix);
+        sif::printWarning("Error description: %s\n", strerror(errno));
+#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
+#endif /* FSFW_VERBOSE_LEVEL >= 1 */
+        openStatus = OPEN_FILE_FAILED;
+    }
+}
+
+utility::UnixFileHelper::~UnixFileHelper() {
+    if(fileDescriptor != nullptr) {
+        close(*fileDescriptor);
+    }
+}
+
+ReturnValue_t utility::UnixFileHelper::getOpenResult() const {
+    return openStatus;
+}
+

linux/utility/Utility.h

@@ -0,0 +1,36 @@
+#ifndef LINUX_UTILITY_UTILITY_H_
+#define LINUX_UTILITY_UTILITY_H_
+
+#include <cerrno>
+#include <cstring>
+#include <fsfw/serviceinterface/ServiceInterface.h>
+
+#include <fcntl.h>
+#include <unistd.h>
+
+namespace utility {
+
+void handleIoctlError(const char* const customPrintout);
+
+class UnixFileHelper {
+public:
+    static constexpr int READ_WRITE_FLAG = O_RDWR;
+    static constexpr int READ_ONLY_FLAG = O_RDONLY;
+    static constexpr int NON_BLOCKING_IO_FLAG = O_NONBLOCK;
+
+    static constexpr ReturnValue_t OPEN_FILE_FAILED = 1;
+
+    UnixFileHelper(std::string device, int* fileDescriptor, int flags,
+            std::string diagnosticPrefix = "");
+
+    virtual~ UnixFileHelper();
+
+    ReturnValue_t getOpenResult() const;
+private:
+    int* fileDescriptor = nullptr;
+    ReturnValue_t openStatus = HasReturnvaluesIF::RETURN_OK;
+};
+
+}
+
+#endif /* LINUX_UTILITY_UTILITY_H_ */

linux/utility/utility.h

@@ -1,77 +0,0 @@
-#ifndef LINUX_UTILITY_UTILITY_H_
-#define LINUX_UTILITY_UTILITY_H_
-
-#include <cerrno>
-#include <cstring>
-#include <fsfw/serviceinterface/ServiceInterface.h>
-
-#include <fcntl.h>
-#include <unistd.h>
-
-namespace utility {
-
-void handleIoctlError(const char* const customPrintout) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    if(customPrintout != nullptr) {
-        sif::warning << customPrintout << std::endl;
-    }
-    sif::warning << "handleIoctlError: Error code " << errno << ", "<< strerror(errno) <<
-            std::endl;
-#else
-    if(customPrintout != nullptr) {
-        sif::printWarning("%s\n", customPrintout);
-    }
-    sif::printWarning("handleIoctlError: Error code %d, %s\n", errno, strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-
-}
-
-class UnixFileHelper {
-public:
-    static constexpr int READ_WRITE_FLAG = O_RDWR;
-    static constexpr int READ_ONLY_FLAG = O_RDONLY;
-    static constexpr int NON_BLOCKING_IO_FLAG = O_NONBLOCK;
-
-    static constexpr ReturnValue_t OPEN_FILE_FAILED = 1;
-
-    UnixFileHelper(std::string device, int* fileDescriptor, int flags,
-            std::string diagnosticPrefix = ""):
-            fileDescriptor(fileDescriptor) {
-        if(fileDescriptor == nullptr) {
-            return;
-        }
-        *fileDescriptor = open(device.c_str(), flags);
-        if (*fileDescriptor < 0) {
-    #if FSFW_VERBOSE_LEVEL >= 1
-    #if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << diagnosticPrefix <<"Opening device failed with error code " << errno <<
-                    "." << std::endl;
-            sif::warning << "Error description: " << strerror(errno) << std::endl;
-    #else
-            sif::printError("%sOpening device failed with error code %d.\n", diagnosticPrefix);
-            sif::printWarning("Error description: %s\n", strerror(errno));
-    #endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-    #endif /* FSFW_VERBOSE_LEVEL >= 1 */
-            openStatus = OPEN_FILE_FAILED;
-        }
-    }
-
-    virtual~ UnixFileHelper() {
-        if(fileDescriptor != nullptr) {
-            close(*fileDescriptor);
-        }
-    }
-
-    ReturnValue_t getOpenResult() const {
-        return openStatus;
-    }
-private:
-    int* fileDescriptor = nullptr;
-    ReturnValue_t openStatus = HasReturnvaluesIF::RETURN_OK;
-};
-
-}
-
-#endif /* LINUX_UTILITY_UTILITY_H_ */