Added logger - functional

2023-01-16 15:58:24 +01:00
parent f2967862b6
commit 0dfa8fad2b
7 changed files with 482 additions and 21 deletions
@@ -0,0 +1,182 @@
+// --------------------------------------------------------------------------------------------------------------------
+/// \file  logger.h
+/// \brief File description
+// --------------------------------------------------------------------------------------------------------------------
+//
+// vbchaos software design
+// 
+// --------------------------------------------------------------------------------------------------------------------
+/// $Revision: $
+/// $Author: $
+/// $Date: $
+//  (c) 2023 vbchaos
+// --------------------------------------------------------------------------------------------------------------------
+
+
+#ifndef MAIN_INC_LOGGER_H_
+#define MAIN_INC_LOGGER_H_
+
+/**
+ * Logger implementation
+ * \defgroup Logger
+ * \brief Implementation of a non-blocking logger for debug purpose
+ * \ingroup Platform
+ *
+ * A non-blocking logger that implements its own task with very low (unimportant)
+ * priority
+ * @{
+ */
+
+
+// --------------------------------------------------------------------------------------------------------------------
+// Include files 
+// --------------------------------------------------------------------------------------------------------------------
+
+// CompilerIncludes
+//  All include files that are provided by the compiler directly
+#include <stdbool.h>
+#include <stdint.h>
+
+
+// ProjectIncludes
+// All include files that are provided by the project
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/queue.h"
+#include "freertos/semphr.h"
+
+#include "driver/uart_select.h"
+
+// --------------------------------------------------------------------------------------------------------------------
+// Constant and macro definitions 
+// --------------------------------------------------------------------------------------------------------------------
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_ERROR(...) \
+   Logger_log(__FILE__, __func__, __LINE__, LOGTYPE_ERROR, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_WARNING(...) \
+   Logger_log(__FILE__, __func__, __LINE__, LOGTYPE_WARNING, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_INFO(...) \
+   Logger_log(__FILE__, __func__, __LINE__, LOGTYPE_INFO, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_DEBUG(...) \
+   Logger::Logger_log(__FILE__, __func__, __LINE__, LOGTYPE_DEBUG, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_PRINT(...) \
+   Logger_log("", "", 0, LOGTYPE_PRINT, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_ERROR_ISR(...) \
+   Logger_logISR(__FILE__, __func__, __LINE__, LOGTYPE_ERROR, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_WARNING_ISR(...) \
+   Logger_logISR(__FILE__, __func__, __LINE__, LOGTYPE_WARNING, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_INFO_ISR(...) \
+   Logger_logISR(__FILE__, __func__, __LINE__, LOGTYPE_INFO, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_DEBUG_ISR(a, ...) \
+   Logger_logISR(a, __FILE__, __func__, __LINE__, LOGTYPE_DEBUG, ##__VA_ARGS__)
+
+/**
+ * Logs an error
+ * \memberof Logger
+ */
+#define LOGGER_PRINT_ISR(a, ...) \
+   Logger_logISR(a, "", "", 0, LOGTYPE_PRINT, ##__VA_ARGS__)
+
+// --------------------------------------------------------------------------------------------------------------------
+// Type definitions. 
+// --------------------------------------------------------------------------------------------------------------------
+
+typedef enum
+{
+   LOGTYPE_PRINT,    /**< Raw print                                             */
+   LOGTYPE_DEBUG,    /**< Debug information only; will not be stored on SD-card */
+   LOGTYPE_INFO,     /**< Informational messages of important events            */
+   LOGTYPE_WARNING,  /**< Recoverable fault                                     */
+   LOGTYPE_SUCCESS,  /**< A specific success message                            */
+   LOGTYPE_ERROR     /**< Unrecoverable fault                                   */
+} LogType;
+
+
+struct LogQueueItem
+{
+   char fileName[32];
+   char functionName[32];
+   char context[128];
+   int lineNumber;
+   LogType logType;
+};
+
+// --------------------------------------------------------------------------------------------------------------------
+// Function declarations 
+// --------------------------------------------------------------------------------------------------------------------
+
+
+class Logger
+{
+   public:
+      static uart_port_t uartPort;
+      static int queuesize;
+      static QueueHandle_t logQueue;
+
+      Logger(int queuesize, uart_port_t uartPort);
+
+      static void Logger_log(const char* fileName, const char* functionName, int lineNumber, LogType logType, const char* format, ...);
+
+      static void Logger_logISR(struct Logger* self, const char* fileName, const char* functionName, int lineNumber, LogType logType, const char* context);
+
+   private:
+      static TaskHandle_t logTaskHandle;
+
+      static void loggerTask(void* parameters);
+
+      static void composeLogQueueItem(struct LogQueueItem* logQueueItem, const char* fileName, const char* functionName,
+          int lineNumber, LogType logType, const char* context);
+};
+
+
+
+
+
+
+/** @} */
+
+#endif /* MAIN_INC_LOGGER_H_ */