Logging for Interface

interfaces/CMakeLists.txt

@@ -11,6 +11,9 @@ set(INCLUDE_DIRS
     ${CMAKE_CURRENT_SOURCE_DIR}/obc_gs_interface/fec
 
     ${CMAKE_CURRENT_SOURCE_DIR}/data_pack_unpack
+
+    ${CMAKE_CURRENT_SOURCE_DIR}/../obc/app/sys/logging
+    ${CMAKE_CURRENT_SOURCE_DIR}/../obc/app/sys
 )
 
 set(SOURCES
@@ -35,7 +38,15 @@ set(SOURCES
 add_library(${OBC_GS_INTERFACE_LIB_NAME} STATIC ${SOURCES})
 target_include_directories(${OBC_GS_INTERFACE_LIB_NAME} PUBLIC ${INCLUDE_DIRS})
 
+if(CMAKE_BUILD_TYPE MATCHES OBC)
+    target_compile_definitions(${OBC_GS_INTERFACE_LIB_NAME} PUBLIC BUILD_TYPE_OBC_FW)
+
+elseif(CMAKE_BUILD_TYPE MATCHES GS)
+    target_compile_definitions(${OBC_GS_INTERFACE_LIB_NAME} PUBLIC BUILD_TYPE_OBC_GS)
+
+endif()
+
 target_link_libraries(${OBC_GS_INTERFACE_LIB_NAME} PRIVATE
     tiny-aes
     lib-correct
-)
+)

interfaces/obc_gs_interface/aes128/obc_gs_aes128.c

@@ -1,5 +1,6 @@
 #include "obc_gs_aes128.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <aes.h>
 

interfaces/obc_gs_interface/ax25/obc_gs_ax25.c

@@ -1,5 +1,6 @@
 #include "obc_gs_ax25.h"
 #include "obc_gs_crc.h"
+#include "obc_logging.h"
 
 #include <stdint.h>
 #include <string.h>

interfaces/obc_gs_interface/commands/obc_gs_command_pack.c

@@ -3,6 +3,7 @@
 #include "obc_gs_command_id.h"
 #include "data_pack_utils.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <stdbool.h>
 #include <stdint.h>

interfaces/obc_gs_interface/commands/obc_gs_command_unpack.c

@@ -3,6 +3,7 @@
 #include "obc_gs_command_id.h"
 #include "data_unpack_utils.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <stdbool.h>
 #include <stdint.h>

interfaces/obc_gs_interface/commands/obc_gs_commands_response_pack.c

@@ -1,6 +1,7 @@
 
 #include "data_pack_utils.h"
 #include "obc_gs_commands_response_pack.h"
+#include "obc_logging.h"
 
 #include <stdint.h>
 #include <string.h>

interfaces/obc_gs_interface/commands/obc_gs_commands_response_unpack.c

@@ -1,6 +1,7 @@
 #include "data_unpack_utils.h"
 #include "obc_gs_commands_response_unpack.h"
 #include "obc_gs_command_id.h"
+#include "obc_logging.h"
 
 #include <stdint.h>
 #include <string.h>

interfaces/obc_gs_interface/fec/obc_gs_fec.c

@@ -1,6 +1,7 @@
 #include "obc_gs_fec.h"
 #include "obc_gs_aes128.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <correct.h>
 

interfaces/obc_gs_interface/telemetry/obc_gs_telemetry_pack.c

@@ -3,6 +3,7 @@
 #include "obc_gs_telemetry_id.h"
 #include "data_pack_utils.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <stddef.h>
 #include <stdint.h>

interfaces/obc_gs_interface/telemetry/obc_gs_telemetry_unpack.c

@@ -3,6 +3,7 @@
 #include "obc_gs_telemetry_id.h"
 #include "data_unpack_utils.h"
 #include "obc_gs_errors.h"
+#include "obc_logging.h"
 
 #include <stddef.h>
 #include <stdint.h>

obc/app/sys/logging/obc_logging.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "obc_errors.h"
+#include "obc_gs_errors.h"
 
 #include <stdint.h>
 #include <stdarg.h>
@@ -42,6 +43,8 @@ typedef enum { LOG_TYPE_ERROR_CODE = 0, LOG_TYPE_MSG = 1 } log_type_t;
 #define LOG_DEFAULT_LEVEL LOG_TRACE
 #endif
 
+#ifdef BUILD_TYPE_OBC_FW
+
 #define LOG_TRACE(msg) logMsg(LOG_TRACE, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
 #define LOG_DEBUG(msg) logMsg(LOG_DEBUG, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
 #define LOG_INFO(msg) logMsg(LOG_INFO, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
@@ -146,3 +149,101 @@ obc_error_code_t logErrorCodeFromISR(log_level_t msgLevel, const char *file, uin
  *
  */
 obc_error_code_t logMsgFromISR(log_level_t msgLevel, const char *file, uint32_t line, const char *msg);
+
+#else
+
+#ifdef BUILD_TYPE_OBC_GS
+
+#define LOG_TRACE(msg) gsLogMsg(LOG_TRACE, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+#define LOG_DEBUG(msg) gsLogMsg(LOG_DEBUG, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+#define LOG_INFO(msg) gsLogMsg(LOG_INFO, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+#define LOG_WARN(msg) gsLogMsg(LOG_WARN, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+#define LOG_ERROR(msg) gsLogMsg(LOG_ERROR, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+#define LOG_FATAL(msg) gsLogMsg(LOG_FATAL, __FILE_FROM_REPO_ROOT__, __LINE__, msg)
+
+#define LOG_TRACE_FROM_ISR(msg) LOG_TRACE(msg)
+#define LOG_DEBUG_FROM_ISR(msg) LOG_DEBUG(msg)
+#define LOG_INFO_FROM_ISR(msg) LOG_INFO(msg)
+#define LOG_WARN_FROM_ISR(msg) LOG_WARN(msg)
+#define LOG_ERROR_FROM_ISR(msg) LOG_ERROR(msg)
+#define LOG_FATAL_FROM_ISR(msg) LOG_FATAL(msg)
+
+#define LOG_ERROR_CODE(errCode) gsLogErrorCode(LOG_ERROR, __FILE_FROM_REPO_ROOT__, __LINE__, errCode)
+#define LOG_ERROR_CODE_FROM_ISR(errCode) gsLogErrorCode(LOG_ERROR, __FILE_FROM_REPO_ROOT__, __LINE__, errCode)
+
+#define RETURN_IF_ERROR_CODE(_ret)            \
+  do {                                        \
+    errCode = _ret;                           \
+    if (errCode != OBC_GS_ERR_CODE_SUCCESS) { \
+      LOG_ERROR_CODE(errCode);                \
+      return errCode;                         \
+    }                                         \
+  } while (0)
+
+#define LOG_IF_ERROR_CODE(_ret)               \
+  do {                                        \
+    errCode = _ret;                           \
+    if (errCode != OBC_GS_ERR_CODE_SUCCESS) { \
+      LOG_ERROR_CODE(errCode);                \
+    }                                         \
+  } while (0)
+
+  /**
+ * @brief Log an error code
+ *
+ * @param msgLevel Level of the message
+ * @param file File of message
+ * @param line Line of message
+ * @param errCode the error code that needs to be logged
+ * @return obc_gs_error_code_t OBC_GS_ERR_CODE_LOG_MSG_SILENCED if msgLevel is lower than logging level
+ *                              OBC_GS_ERR_CODE_BUFF_TOO_SMALL if logged message is too long
+ *                              OBC_GS_ERR_CODE_INVALID_ARG if file or s are null or if there is an encoding error
+ *                              OBC_GS_ERR_CODE_SUCCESS if message is successfully logged
+ *                              OBC_GS_ERR_CODE_UNKNOWN otherwise
+ */
+obc_gs_error_code_t gsLogErrorCode(gs_log_level_t msgLevel, const char *file, uint32_t line, uint32_t errCode);
+
+/**
+ * @brief Log a message
+ *
+ * @param msgLevel Level of the message
+ * @param file File of message
+ * @param line Line of message
+ * @param msg the message that should be logged (MUST BE STATIC)
+ * @return obc_gs_error_code_t OBC_GS_ERR_CODE_LOG_MSG_SILENCED if msgLevel is lower than logging level
+ *                              OBC_GS_ERR_CODE_BUFF_TOO_SMALL if logged message is too long
+ *                              OBC_GS_ERR_CODE_INVALID_ARG if file or s are null or if there is an encoding error
+ *                              OBC_GS_ERR_CODE_SUCCESS if message is successfully logged
+ *                              OBC_GS_ERR_CODE_UNKNOWN otherwise
+ */
+obc_gs_error_code_t gsLogMsg(gs_log_level_t msgLevel, const char *file, uint32_t line, const char *msg);
+
+  #else
+
+  #define LOG_DEBUG(msg) ((void)0)
+  #define LOG_INFO(msg) ((void)0)
+  #define LOG_WARN(msg) ((void)0)
+  #define LOG_ERROR(msg) ((void)0)
+  #define LOG_FATAL(msg) ((void)0)
+  #define LOG_TRACE_FROM_ISR(msg) ((void)0)
+  #define LOG_DEBUG_FROM_ISR(msg) ((void)0)
+  #define LOG_INFO_FROM_ISR(msg) ((void)0)
+  #define LOG_WARN_FROM_ISR(msg) ((void)0)
+  #define LOG_ERROR_FROM_ISR(msg) ((void)0)
+  #define LOG_FATAL_FROM_ISR(msg) ((void)0)
+  #define LOG_ERROR_CODE(errCode) ((void)0)
+  #define LOG_ERROR_CODE_FROM_ISR(errCode) ((void)0)
+
+  #define RETURN_IF_ERROR_CODE(_ret)            \
+    do {                                        \
+      (void)(_ret);                             \
+      return _ret;                              \
+    } while (0)
+
+  #define LOG_IF_ERROR_CODE(_ret)               \
+    do {                                        \
+      (void)(_ret);                             \
+    } while (0)
+  #endif
+
+  #endif