Add support for the mGBA logging system.

This uses IO registers to allow a game to log in the emulator's console.

Author: Arignir

accuracy/suite.py

@@ -137,7 +137,7 @@ class TestRoms(Enum):
             key a true
             frame 20
             key a false
-            frame 100
+            frame 220
 
             screenshot ./.tests_screenshots/mgba_suite_memory.png
         ''',
@@ -169,7 +169,7 @@ class TestRoms(Enum):
             key a true
             frame 20
             key a false
-            frame 200
+            frame 290
 
             screenshot ./.tests_screenshots/mgba_suite_timing.png
         ''',
@@ -185,7 +185,7 @@ class TestRoms(Enum):
             key a true
             frame 20
             key a false
-            frame 150
+            frame 200
 
             screenshot ./.tests_screenshots/mgba_suite_timer_count_up.png
         ''',
@@ -214,7 +214,7 @@ class TestRoms(Enum):
             frame 70
             key down false
             key a true
-            frame 20
+            frame 30
             key a false
 
             screenshot ./.tests_screenshots/mgba_suite_shifter.png
@@ -244,7 +244,7 @@ class TestRoms(Enum):
             frame 85
             key down false
             key a true
-            frame 20
+            frame 30
             key a false
 
             screenshot ./.tests_screenshots/mgba_suite_multiply_long.png
@@ -259,7 +259,7 @@ class TestRoms(Enum):
             frame 95
             key down false
             key a true
-            frame 20
+            frame 80
             key a false
 
             screenshot ./.tests_screenshots/mgba_suite_bios.png
@@ -276,7 +276,7 @@ class TestRoms(Enum):
             key a true
             frame 20
             key a false
-            frame 130
+            frame 250
 
             screenshot ./.tests_screenshots/mgba_suite_dma.png
         ''',

include/gba/io.h

@@ -170,9 +170,28 @@ enum io_regs {
     IO_REG_HALTCNT      = 0x04000301,
     IO_REG_UNKNOWN_3    = 0x04000302,
 
+#ifdef WITH_DEBUGGER
+    IO_REG_MGBA_LOG_BUFFER      = 0x04FFF600,
+    IO_REG_MGBA_LOG_BUFFER_END  = 0x04FFF700,
+    IO_REG_MGBA_LOG_FLAGS       = 0x04FFF700,
+    IO_REG_MGBA_LOG_ENABLE      = 0x04FFF780,
+#endif
+
     IO_REG_END,
 };
 
+#ifdef WITH_DEBUGGER
+#define MGBA_LOG_BUFFER_SIZE    (IO_REG_MGBA_LOG_BUFFER_END - IO_REG_MGBA_LOG_BUFFER)
+
+enum mgba_log_level {
+    MGBA_LOG_FATAL = 0x01,
+    MGBA_LOG_ERROR = 0x02,
+    MGBA_LOG_WARN = 0x04,
+    MGBA_LOG_INFO = 0x08,
+    MGBA_LOG_DEBUG = 0x10,
+};
+#endif
+
 /*
 ** A DMA channel and the content of the different IO registers associated with it.
 */
@@ -856,6 +875,27 @@ struct io {
             uint8_t bytes[2];
         } ime;
     } pending;
+
+#ifdef WITH_DEBUGGER
+    struct {
+        union {
+            uint16_t raw;
+            uint8_t bytes[2];
+        } enable;
+
+        union {
+            struct {
+                uint16_t level: 4;
+                uint16_t : 4;
+                uint16_t send: 1;
+            } __packed;
+            uint16_t raw;
+            uint8_t bytes[2];
+        } flags;
+
+        uint8_t buffer[MGBA_LOG_BUFFER_SIZE + 1];
+    } mgba_log ;
+#endif
 };
 
 static_assert(sizeof(((struct io *)NULL)->dispcnt) == sizeof(uint16_t));

include/log.h

@@ -16,7 +16,7 @@ enum modules {
     HS_INFO      = 0,
 
     HS_ERROR,
-    HS_WARNING,
+    HS_WARN,
 
     HS_CORE,
     HS_IO,
@@ -60,7 +60,7 @@ extern bool g_verbose_global;
 static char const * const modules_str[] = {
     [HS_INFO]       = " INFO  ",
     [HS_ERROR]      = " ERROR ",
-    [HS_WARNING]    = " WARN  ",
+    [HS_WARN]       = " WARN  ",
     [HS_CORE]       = " CORE  ",
     [HS_IO]         = " IO    ",
     [HS_VIDEO]      = " VIDEO ",

source/app/dbg/cmd/verbose.c

@@ -21,7 +21,7 @@ struct verbosity_arg verbosities[] = {
     { "global",     &g_verbose_global       },
 
     { "info",       g_verbose + HS_INFO     },
-    { "warn",       g_verbose + HS_WARNING  },
+    { "warn",       g_verbose + HS_WARN     },
     { "err",        g_verbose + HS_ERROR    },
 
     { "io",         g_verbose + HS_IO       },

source/app/emulator.c

@@ -469,15 +469,15 @@ app_emulator_configure_backup_storage(
         read_len = fread(data, 1, file_len, app->emulation.backup_file);
 
         if (read_len != file_len) {
-            logln(HS_WARNING, "Failed to read the save file. Is it corrupted?");
+            logln(HS_WARN, "Failed to read the save file. Is it corrupted?");
         } else {
             logln(HS_INFO, "Save file successfully read.");
         }
 
         app->emulation.launch_config->backup_storage.data = data;
         app->emulation.launch_config->backup_storage.size = file_len;
     } else {
-        logln(HS_WARNING, "Failed to open the save file. A new one will be created instead.");
+        logln(HS_WARN, "Failed to open the save file. A new one will be created instead.");
 
         app->emulation.backup_file = hs_fopen(backup_path, "wb+");
 
@@ -529,7 +529,7 @@ app_emulator_import_backup_storage(
     read_len = fread(data, 1, file_len, backup);
 
     if (read_len != file_len) {
-        logln(HS_WARNING, "Failed to import the save file. Is it corrupted?");
+        logln(HS_WARN, "Failed to import the save file. Is it corrupted?");
     } else {
         app_new_notification(
             app,
@@ -545,7 +545,7 @@ app_emulator_import_backup_storage(
     app->emulation.backup_file = hs_fopen(backup_path, "rb+");
 
     if (!app->emulation.backup_file) {
-        logln(HS_WARNING, "Failed to open the save file. A new one will be created instead.");
+        logln(HS_WARN, "Failed to open the save file. A new one will be created instead.");
 
         app->emulation.backup_file = hs_fopen(backup_path, "wb+");
 
@@ -637,11 +637,9 @@ app_emulator_configure_and_run(
         );
     } else {
         logln(
-            HS_WARNING,
-            "No game with the code \"%s%.3s%s\" could be found in the Hades game database.",
-            g_light_magenta,
-            code,
-            g_reset
+            HS_WARN,
+            "No game with the code \"%.3s\" could be found in the Hades game database.",
+            code
         );
 
         app->emulation.game_entry = db_autodetect_game_features(app->emulation.launch_config->rom.data, app->emulation.launch_config->rom.size);
@@ -1011,7 +1009,7 @@ app_emulator_quickload(
     size_t size;
 
     if (app->emulation.quickload_request.enabled) {
-        logln(HS_WARNING, "A saved state is already being loaded by the emulator, ignoring the new request.");
+        logln(HS_WARN, "A saved state is already being loaded by the emulator, ignoring the new request.");
         return;
     }
 

source/gba/db.c

@@ -1792,7 +1792,7 @@ db_autodetect_game_features(
 
     if (array_search(rom, rom_size, "EEPROM_V", 7)) {
         logln(HS_INFO, "Detected EEPROM 64K memory.");
-        logln(HS_WARNING, "If you are having issues with corrupted saves, try EEPROM 8K instead.");
+        logln(HS_WARN, "If you are having issues with corrupted saves, try EEPROM 8K instead.");
         entry->storage = BACKUP_EEPROM_64K;
     } else if (
            array_search(rom, rom_size, "SRAM_V", 5)

source/gba/memory/io.c

@@ -7,6 +7,15 @@
 **
 \******************************************************************************/
 
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+#include "gba/io.h"
+
 #include <string.h>
 #include "memory.h"
 #include "gba/gba.h"
@@ -355,6 +364,12 @@ mem_io_read8(
 
         /* System */
         case IO_REG_POSTFLG:                return (io->postflg);
+
+        /* mGBA logging system */
+#ifdef WITH_DEBUGGER
+        case IO_REG_MGBA_LOG_ENABLE:            return (io->mgba_log.enable.bytes[0]);
+        case IO_REG_MGBA_LOG_ENABLE + 1:        return (io->mgba_log.enable.bytes[1]);
+#endif
     }
     return (mem_openbus_read(gba, addr));
 }
@@ -821,6 +836,50 @@ mem_io_write8(
             }
             break;
         };
+
+        /* mGBA logging system */
+#ifdef WITH_DEBUGGER
+        case IO_REG_MGBA_LOG_BUFFER ... IO_REG_MGBA_LOG_BUFFER_END - 1: {
+            io->mgba_log.buffer[addr - IO_REG_MGBA_LOG_BUFFER] = val;
+            break;
+        }
+        case IO_REG_MGBA_LOG_FLAGS: io->mgba_log.flags.bytes[0] = val; break;
+        case IO_REG_MGBA_LOG_FLAGS + 1: {
+            io->mgba_log.flags.bytes[1] = val;
+
+            if (io->mgba_log.flags.send) {
+                enum modules module;
+                int level;
+
+                level = 1 << io->mgba_log.flags.level;
+                level &= 0x1F;
+
+                switch (level) {
+                    case MGBA_LOG_FATAL:
+                    case MGBA_LOG_ERROR:    module = HS_ERROR; break;
+                    case MGBA_LOG_WARN:     module = HS_WARN; break;
+                    case MGBA_LOG_INFO:     module = HS_INFO; break;
+                    case MGBA_LOG_DEBUG:    module = HS_DEBUG; break;
+                    default:                module = HS_INFO; break;
+                }
+
+                io->mgba_log.buffer[MGBA_LOG_BUFFER_SIZE] = 0x0;
+                logln(module, "%s", io->mgba_log.buffer);
+                memset(io->mgba_log.buffer, 0, MGBA_LOG_BUFFER_SIZE);
+
+                io->mgba_log.flags.send = false;
+            }
+            break;
+        }
+        case IO_REG_MGBA_LOG_ENABLE:
+        case IO_REG_MGBA_LOG_ENABLE + 1: {
+            io->mgba_log.enable.bytes[addr - IO_REG_MGBA_LOG_ENABLE] = val;
+            if (io->mgba_log.enable.raw == 0xC0DE) {
+                io->mgba_log.enable.raw = 0x1DEA;
+            }
+            break;
+        }
+#endif
     }
 }
 

source/gba/scheduler.c

@@ -167,7 +167,7 @@ sched_run_for(
 
         if (!elapsed) {
             if (gba->core.state != CORE_STOP) {
-                logln(HS_WARNING, "No cycles elapsed during `core_next()`.");
+                logln(HS_WARN, "No cycles elapsed during `core_next()`.");
             }
             break;
         }

source/log.c

@@ -17,7 +17,7 @@
 bool g_verbose_global = true;
 bool g_verbose[HS_END] = {
     [HS_INFO] = true,
-    [HS_WARNING] = true,
+    [HS_WARN] = true,
     [HS_ERROR] = true,
 };
 
@@ -84,14 +84,18 @@ logln(
 
         printf("[%s] ", modules_str[module]);
 
-        if (module == HS_ERROR) {
-            printf("%s%s", g_bold, g_light_red);
+        switch (module) {
+            case HS_ERROR: printf("%s%s", g_bold, g_light_red); break;
+            case HS_WARN: printf("%s%s", g_bold, g_light_yellow); break;
+            default: break;
         }
 
         vprintf(fmt, va);
 
-        if (module == HS_ERROR) {
-            printf("%s", g_reset);
+        switch (module) {
+            case HS_ERROR:
+            case HS_WARN: printf("%s", g_reset); break;
+            default: break;
         }
 
         printf("\n");