Move memory training code into it's own stage (fusee-mtc)

fusee/fusee-mtc/src/lib/log.c

@@ -0,0 +1,127 @@
+/*
+ * Copyright (c) 2018-2019 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "log.h"
+
+#include "../display/video_fb.h"
+#include "vsprintf.h"
+
+/* default log level for screen output */
+ScreenLogLevel g_screen_log_level = SCREEN_LOG_LEVEL_NONE;
+
+void log_set_log_level(ScreenLogLevel log_level) {
+    g_screen_log_level = log_level;
+}
+
+ScreenLogLevel log_get_log_level() {
+    return g_screen_log_level;
+}
+
+void log_to_uart(const char *message) {
+    /* TODO: add UART logging */
+}
+
+static void print_to_screen(ScreenLogLevel screen_log_level, char *message) {
+    /* don't print to screen if below log level */
+    if(screen_log_level > g_screen_log_level) return;
+
+    video_puts(message);
+}
+
+/**
+ * vprintk - logs a message and prints it to screen based on its screen_log_level
+ *
+ * If the level is below g_screen_log_level it will not be shown but logged to UART
+ * This text will not be colored or prefixed
+ * UART is TODO
+ */
+void vprint(ScreenLogLevel screen_log_level, const char *fmt, va_list args)
+{
+    char buf[PRINT_MESSAGE_MAX_LENGTH];
+    vsnprintf(buf, PRINT_MESSAGE_MAX_LENGTH, fmt, args);
+
+    /* we don't need that flag here, but if it gets used, strip it so we print correctly */
+    screen_log_level &= ~SCREEN_LOG_LEVEL_NO_PREFIX;
+
+    /* log to UART */
+    log_to_uart(buf);
+
+    print_to_screen(screen_log_level, buf);
+}
+
+static void add_prefix(ScreenLogLevel screen_log_level, const char *fmt, char *buf) {
+    char typebuf[] = "[%s] %s";
+
+    /* apply prefix and append message format */
+    /* TODO: add coloring to the output */
+    switch(screen_log_level)
+    {
+        case SCREEN_LOG_LEVEL_ERROR:
+            snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, typebuf, "ERROR", fmt);
+            break;
+        case SCREEN_LOG_LEVEL_WARNING:
+            snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, typebuf, "WARNING", fmt);
+            break;
+        case SCREEN_LOG_LEVEL_MANDATORY:
+            snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, "%s", fmt);
+            break;
+        case SCREEN_LOG_LEVEL_INFO:
+            snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, typebuf, "INFO", fmt);
+            break;
+        case SCREEN_LOG_LEVEL_DEBUG:
+            snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, typebuf, "DEBUG", fmt);
+            break;
+        default:
+            break;
+    }
+}
+
+/**
+ * print - logs a message and prints it to screen based on its screen_log_level
+ * 
+ * If the level is below g_screen_log_level it will not be shown but logged to UART
+ * Use SCREEN_LOG_LEVEL_NO_PREFIX if you don't want a prefix to be added
+ * UART is TODO
+ */
+void print(ScreenLogLevel screen_log_level, const char * fmt, ...)
+{
+    char buf[PRINT_MESSAGE_MAX_LENGTH] = {};
+    char message[PRINT_MESSAGE_MAX_LENGTH] = {};
+
+    /* TODO: make splash disappear if level > MANDATORY */
+
+    /* make prefix free messages with log_level possible */
+    if(screen_log_level & SCREEN_LOG_LEVEL_NO_PREFIX) {
+        /* remove the NO_PREFIX flag so the enum can be recognized later on */
+        screen_log_level &= ~SCREEN_LOG_LEVEL_NO_PREFIX;
+
+        snprintf(buf, PRINT_MESSAGE_MAX_LENGTH, "%s", fmt);
+    }
+    else {
+        add_prefix(screen_log_level, fmt, buf);
+    }
+
+    /* input arguments */
+    va_list args;
+    va_start(args, fmt);
+    vsnprintf(message, PRINT_MESSAGE_MAX_LENGTH, buf, args);
+    va_end(args);
+
+    /* log to UART */
+    log_to_uart(message);
+
+    print_to_screen(screen_log_level, message);
+}

fusee/fusee-mtc/src/lib/log.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2018-2019 Atmosphère-NX
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef FUSEE_LOG_H
+#define FUSEE_LOG_H
+
+#define PRINT_MESSAGE_MAX_LENGTH 512
+
+#include <stdarg.h>
+
+typedef enum {
+    SCREEN_LOG_LEVEL_NONE       = 0,
+    SCREEN_LOG_LEVEL_ERROR      = 1,
+    SCREEN_LOG_LEVEL_WARNING    = 2,
+    SCREEN_LOG_LEVEL_MANDATORY  = 3, /* no log prefix */
+    SCREEN_LOG_LEVEL_INFO       = 4,
+    SCREEN_LOG_LEVEL_DEBUG      = 5,
+
+    SCREEN_LOG_LEVEL_NO_PREFIX  = 0x100 /* OR this to your LOG_LEVEL to prevent prefix creation */
+} ScreenLogLevel;
+
+extern ScreenLogLevel g_screen_log_level;
+
+void log_set_log_level(ScreenLogLevel screen_log_level);
+ScreenLogLevel log_get_log_level();
+void log_to_uart(const char *message);
+void vprint(ScreenLogLevel screen_log_level, const char *fmt, va_list args);
+void print(ScreenLogLevel screen_log_level, const char* fmt, ...);
+
+#endif

fusee/fusee-mtc/src/lib/vsprintf.h

@@ -0,0 +1,28 @@
+/*
+ *  Copyright (C) 2011 Andrei Warkentin <andrey.warkentin@gmail.com>
+ *
+ * This program is free software ; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#include <stdarg.h>
+#include <stdlib.h>
+
+#ifndef VSPRINTF_H
+#define VSPRINTF_H
+
+struct va_format {
+        const char *fmt;
+        va_list *va;
+};
+
+unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base);
+
+int sprintf(char *buf, const char *fmt, ...);
+int scnprintf(char *buf, size_t size, const char *fmt, ...);
+int snprintf(char *buf, size_t size, const char *fmt, ...);
+int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
+int sscanf(const char *buf, const char *fmt, ...);
+
+#endif /* VSPRINTF_H */