Updater: Some more work on the UI, still no flashing

ducalex · ducalex · commit 7fe738120d91 · 2025-09-06T20:32:30.000-04:00
diff --git a/components/retro-go/rg_gui.c b/components/retro-go/rg_gui.c
@@ -1041,7 +1041,7 @@ static int file_picker_cb(const rg_scandir_t *entry, void *arg)
     return RG_SCANDIR_CONTINUE;
 }
 
-char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(const char *path), bool none_option)
+char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(const char *path), bool browse_tree, bool none_option)
 {
     file_picker_opts_t options = {
         .options = calloc(8, sizeof(rg_gui_option_t)),
@@ -1056,6 +1056,9 @@ char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(
     if (none_option)
         options.options[options.count++] = (rg_gui_option_t){0, _("<None>"), NULL, RG_DIALOG_FLAG_NORMAL, NULL};
 
+    // if (browse_tree)
+    //     options.options[options.count++] = (rg_gui_option_t){0, "...", NULL, RG_DIALOG_FLAG_NORMAL, NULL};
+
     if (!rg_storage_scandir(path, file_picker_cb, &options, 0) || options.count < 1)
     {
         rg_gui_alert(title, _("Folder is empty."));
@@ -1070,6 +1073,9 @@ char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(
         if (filename)
             snprintf(buffer, RG_PATH_MAX, "%s/%s", path, filename);
         filepath = strdup(buffer);
+        // if (browse_tree && rg_storage_stat(filepath).is_dir)
+        // {
+        // }
     }
 
 cleanup:
@@ -1667,7 +1673,7 @@ static rg_gui_event_t theme_cb(rg_gui_option_t *option, rg_gui_event_t event)
 {
     if (event == RG_DIALOG_ENTER)
     {
-        char *path = rg_gui_file_picker("Theme", RG_BASE_PATH_THEMES, NULL, true);
+        char *path = rg_gui_file_picker("Theme", RG_BASE_PATH_THEMES, NULL, false, true);
         if (path != NULL)
         {
             const char *theme = strlen(path) > 0 ? rg_basename(path) : NULL;
@@ -1713,7 +1719,7 @@ static rg_gui_event_t border_update_cb(rg_gui_option_t *option, rg_gui_event_t e
 {
     if (event == RG_DIALOG_ENTER)
     {
-        char *path = rg_gui_file_picker("Border", RG_BASE_PATH_BORDERS, NULL, true);
+        char *path = rg_gui_file_picker("Border", RG_BASE_PATH_BORDERS, NULL, false, true);
         if (path != NULL)
         {
             rg_display_set_border(strlen(path) ? path : NULL);
diff --git a/components/retro-go/rg_gui.h b/components/retro-go/rg_gui.h
@@ -132,7 +132,7 @@ void rg_gui_draw_message(const char *format, ...);
 intptr_t rg_gui_dialog(const char *title, const rg_gui_option_t *options, int selected_index);
 bool rg_gui_confirm(const char *title, const char *message, bool default_yes);
 void rg_gui_alert(const char *title, const char *message);
-char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(const char *path), bool none_option);
+char *rg_gui_file_picker(const char *title, const char *path, bool (*validator)(const char *path), bool browse_tree, bool none_option);
 char *rg_gui_input_str(const char *title, const char *message, const char *default_value);
 int rg_gui_input_char(const rg_keyboard_layout_t *map);
 
diff --git a/prboom-go/main/main.c b/prboom-go/main/main.c
@@ -559,7 +559,7 @@ void app_main()
 
     if (!iwad)
     {
-        iwad = rg_gui_file_picker("Select IWAD file", I_DoomExeDir(), is_iwad, false) ?: "";
+        iwad = rg_gui_file_picker("Select IWAD file", I_DoomExeDir(), is_iwad, false, false) ?: "";
         rg_gui_draw_hourglass(); // Redraw hourglass to indicate loading...
     }
 
diff --git a/rg_tool.py b/rg_tool.py
@@ -7,6 +7,9 @@
 import sys
 import re
 import os
+import struct
+import time
+import zlib
 
 DEFAULT_TARGET = os.getenv("RG_TOOL_TARGET", "odroid-go")
 DEFAULT_BAUD = os.getenv("RG_TOOL_BAUD", "1152000")
@@ -58,6 +61,7 @@
     ESPTOOL_PY = "esptool.py"
     PARTTOOL_PY = "parttool.py"
     GEN_ESP32PART_PY = "gen_esp32part.py"
+MKIMG_PY = os.path.join("tools", "mkimg.py")
 MKFW_PY = os.path.join("tools", "mkfw.py")
 
 
@@ -68,9 +72,9 @@ def run(cmd, cwd=None, check=True):
     return subprocess.run(cmd, shell=False, cwd=cwd, check=check)
 
 
-def build_firmware(output_file, apps, fw_format="odroid-go", fatsize=0):
+def build_firmware(output_file, apps, fw_format="odroid-go", fatsize=0, info_target="unknown", info_version="unknown"):
     print("Building firmware with: %s\n" % " ".join(apps))
-    args = [MKFW_PY, output_file, f"{PROJECT_NAME} {PROJECT_VER}", PROJECT_ICON]
+    args = [MKFW_PY, output_file, f"{PROJECT_NAME} {info_version}", PROJECT_ICON]
 
     if fw_format == "esplay":
         args.append("--esplay")
@@ -82,7 +86,7 @@ def build_firmware(output_file, apps, fw_format="odroid-go", fatsize=0):
     run(args)
 
 
-def build_image(output_file, apps, img_format="esp32", fatsize=0):
+def build_image(output_file, apps, img_format="esp32", fatsize=0, info_target="unknown", info_version="unknown"):
     print("Building image with: %s\n" % " ".join(apps))
     image_data = bytearray(b"\xFF" * 0x10000)
     table_ota = 0
@@ -128,6 +132,17 @@ def build_image(output_file, apps, img_format="esp32", fatsize=0):
         image_data[0x1000:0x1000+len(bootloader_bin)] = bootloader_bin
         image_data[0x8000:0x8000+len(table_bin)] = table_bin
 
+    # Append the information structure used by retro-go's updater.
+    image_data += struct.pack(
+        "<III32s32s180s",
+        0x31304752,             # Magic number "RG01"
+        zlib.crc32(image_data), # CRC of the image not including this footer
+        int(time.time()),       # Unix timestamp
+        info_target.encode(),   # Name of the target device
+        info_version.encode(),  # Version
+        b"\xFF" * 256,          # 0xFF padding of the reserved area
+    )
+
     with open(output_file, "wb") as f:
         f.write(image_data)
 
@@ -259,14 +274,14 @@ def monitor_app(app, port, baudrate=115200):
         print("=== Step: Packing ===\n")
         if FW_FORMAT in ["odroid", "esplay"]:
             fw_file = ("%s_%s_%s.fw" % (PROJECT_NAME, PROJECT_VER, args.target)).lower()
-            build_firmware(fw_file, apps, FW_FORMAT, args.fatsize)
+            build_firmware(fw_file, apps, FW_FORMAT, args.fatsize, args.target, PROJECT_VER)
         else:
             print("Device doesn't support fw format, try build-img!")
 
     if command in ["build-img", "release", "install"]:
         print("=== Step: Packing ===\n")
         img_file = ("%s_%s_%s.img" % (PROJECT_NAME, PROJECT_VER, args.target)).lower()
-        build_image(img_file, apps, IDF_TARGET, args.fatsize)
+        build_image(img_file, apps, IDF_TARGET, args.fatsize, args.target, PROJECT_VER)
 
     if command in ["install"]:
         print("=== Step: Flashing entire image to device ===\n")
diff --git a/updater/main/main.c b/updater/main/main.c
@@ -4,9 +4,11 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <strings.h>
 
-#include <esp_spi_flash.h>
+#include <esp_flash_partitions.h>
 #include <esp_partition.h>
+#include <esp_spi_flash.h>
 
 #ifdef RG_UPDATER_DOWNLOAD_LOCATION
 #define DOWNLOAD_LOCATION RG_UPDATER_DOWNLOAD_LOCATION
@@ -20,28 +22,130 @@
 #define CAN_UPDATE_PARTITION_TABLE 0
 #endif
 
+#define RETRO_GO_IMG_MAGIC 0x31304752 // "RG01"
+typedef struct
+{
+    uint32_t magic;
+    uint32_t crc32;
+    uint32_t timestamp;
+    char target[32];
+    char version[32];
+    char reserved[180];
+} img_info_t;
+
+#define CONFIRM(title, message...)                                 \
+    {                                                              \
+        snprintf(message_buffer, sizeof(message_buffer), message); \
+        if (!rg_gui_confirm(_(title), message_buffer, false))      \
+            return false;                                          \
+        rg_display_clear(C_BLACK);                                 \
+    }
+#define ALERT(title, message...)                                   \
+    {                                                              \
+        snprintf(message_buffer, sizeof(message_buffer), message); \
+        rg_gui_alert(_(title), message_buffer);                    \
+        rg_display_clear(C_BLACK);                                 \
+    }
+#define ERROR(message...)        \
+    {                            \
+        ALERT("Error", message); \
+        return false;            \
+    }
+#define TRY(cond, error_message) \
+    if (!(cond))                 \
+        ERROR(error_message);
+
+static rg_app_t *app;
+static esp_partition_info_t device_partition_table[ESP_PARTITION_TABLE_MAX_ENTRIES];
+static char message_buffer[256];
+
+static bool do_update(const char *filename)
+{
+    esp_partition_info_t partition_table[16]; // ESP_PARTITION_TABLE_MAX_ENTRIES
+    int num_partitions = 0;
+    img_info_t img_info;
+    int filesize = 0;
+    FILE *fp;
+
+    RG_LOGI("Filename: %s", filename);
+    rg_display_clear(C_BLACK);
+
+    TRY(fp = fopen(filename, "rb"), "File open failed");
+    TRY(fseek(fp, 0, SEEK_END) == 0, "File seek failed");
+    TRY(fseek(fp, -sizeof(img_info_t), SEEK_CUR) == 0, "File seek failed");
+    filesize = ftell(fp); // Size without the footer
+    TRY(fread(&img_info, sizeof(img_info), 1, fp), "File read failed");
+
+    img_info.target[sizeof(img_info.target) - 1] = 0;   // Just in case
+    img_info.version[sizeof(img_info.version) - 1] = 0; // Just in case
+
+    if (img_info.magic != RETRO_GO_IMG_MAGIC) // Invalid image
+    {
+        CONFIRM("Warning", "File is not a valid Retro-Go image.\nContinue anyway?");
+    }
+    else if (strcasecmp(img_info.target, RG_TARGET_NAME) != 0) // Wrong target
+    {
+        CONFIRM("Warning",
+                "The file appears to be for a different device.\n"
+                "Current device: %s\n"
+                "Image device: %s\n\n"
+                "Do you want to continue anyway?",
+                RG_TARGET_NAME,
+                img_info.target);
+    }
+    else // Valid image
+    {
+        CONFIRM("Version", "Current version: %s\nNew version: %s\n\nContinue?", app->version, img_info.version);
+    }
+
+    // TODO: Also support images that truncate the first 0x1000, just in case
+    TRY(fseek(fp, ESP_PARTITION_TABLE_OFFSET, SEEK_SET) == 0, "File seek failed");
+    TRY(fread(&partition_table, sizeof(partition_table), 1, fp), "File read failed");
+
+    if (esp_partition_table_verify(partition_table, true, &num_partitions) != ESP_OK)
+        ERROR("File is not a valid esp32 image.\nCannot continue.");
+
+    ALERT("Info", "Image contains %d partitions.", num_partitions);
+
+    // We can work around this, this is for debugging purposes
+    if (memcmp(&device_partition_table, &partition_table, sizeof(partition_table)))
+        ALERT("Error", "Partition table mismatch.");
+
+    return true;
+}
+
 void app_main(void)
 {
-    rg_app_t *app = rg_system_init(32000, NULL, NULL);
+    app = rg_system_init(32000, NULL, NULL);
+    // This is a hack to hide the status bar with bogus speed info. A better solution will be
+    // needed as we still want the battery icon!
+    app->isLauncher = true;
 
     if (!rg_storage_ready())
     {
-        rg_display_clear(C_SKY_BLUE);
-        rg_gui_alert(_("SD Card Error"), _("Storage mount failed.\nMake sure the card is FAT32."));
-        // What do at this point? Reboot? Switch back to launcher?
-        goto launcher;
+        ALERT("Error", "Storage mount failed.\nMake sure the card is FAT32.");
+        rg_system_exit();
     }
 
-    // Hopefully we'll receive the filename from the launcher which has a nicer file browser
-    const char *filename = app->romPath;
-
-    if (!filename || !rg_storage_exists(filename))
-        filename = rg_gui_file_picker(_("Select update"), DOWNLOAD_LOCATION, NULL, true);
-    if (!filename)
-        goto launcher;
+    if (spi_flash_read(ESP_PARTITION_TABLE_OFFSET, &device_partition_table, sizeof(device_partition_table)) != ESP_OK)
+    {
+        ALERT("Error", "Failed to read device's partition table!");
+        rg_system_exit();
+    }
 
-    RG_LOGI("Filename: %s", filename);
+    const char *filename = app->romPath;
+    while (true)
+    {
+        if (!filename || !*filename)
+        {
+            filename = rg_gui_file_picker("Select update", DOWNLOAD_LOCATION, NULL, true, true);
+            if (!filename || !*filename)
+                break;
+        }
+        if (do_update(filename))
+            break;
+        filename = NULL;
+    }
 
-launcher:
-    rg_system_switch_app(RG_APP_LAUNCHER, 0, 0, 0, 0);
+    rg_system_exit();
 }

Original file line number	Diff line number	Diff line change
`@@ -1041,7 +1041,7 @@ static int file_picker_cb(const rg_scandir_t entry, void arg)`
`1041`	`1041`	`return RG_SCANDIR_CONTINUE;`
`1042`	`1042`	`}`
`1043`	`1043`
`1044`		`-char rg_gui_file_picker(const char title, const char path, bool (validator)(const char *path), bool none_option)`
	`1044`	`+char rg_gui_file_picker(const char title, const char path, bool (validator)(const char *path), bool browse_tree, bool none_option)`
`1045`	`1045`	`{`
`1046`	`1046`	`file_picker_opts_t options = {`
`1047`	`1047`	`.options = calloc(8, sizeof(rg_gui_option_t)),`
`@@ -1056,6 +1056,9 @@ char rg_gui_file_picker(const char title, const char path, bool (validator)(`
`1056`	`1056`	`if (none_option)`
`1057`	`1057`	`options.options[options.count++] = (rg_gui_option_t){0, _("<None>"), NULL, RG_DIALOG_FLAG_NORMAL, NULL};`
`1058`	`1058`
	`1059`	`+ // if (browse_tree)`
	`1060`	`+ // options.options[options.count++] = (rg_gui_option_t){0, "...", NULL, RG_DIALOG_FLAG_NORMAL, NULL};`
	`1061`	`+`
`1059`	`1062`	`if (!rg_storage_scandir(path, file_picker_cb, &options, 0) \|\| options.count < 1)`
`1060`	`1063`	`{`
`1061`	`1064`	`rg_gui_alert(title, _("Folder is empty."));`
`@@ -1070,6 +1073,9 @@ char rg_gui_file_picker(const char title, const char path, bool (validator)(`
`1070`	`1073`	`if (filename)`
`1071`	`1074`	`snprintf(buffer, RG_PATH_MAX, "%s/%s", path, filename);`
`1072`	`1075`	`filepath = strdup(buffer);`
	`1076`	`+ // if (browse_tree && rg_storage_stat(filepath).is_dir)`
	`1077`	`+ // {`
	`1078`	`+ // }`
`1073`	`1079`	`}`
`1074`	`1080`
`1075`	`1081`	`cleanup:`
`@@ -1667,7 +1673,7 @@ static rg_gui_event_t theme_cb(rg_gui_option_t *option, rg_gui_event_t event)`
`1667`	`1673`	`{`
`1668`	`1674`	`if (event == RG_DIALOG_ENTER)`
`1669`	`1675`	`{`
`1670`		`- char *path = rg_gui_file_picker("Theme", RG_BASE_PATH_THEMES, NULL, true);`
	`1676`	`+ char *path = rg_gui_file_picker("Theme", RG_BASE_PATH_THEMES, NULL, false, true);`
`1671`	`1677`	`if (path != NULL)`
`1672`	`1678`	`{`
`1673`	`1679`	`const char *theme = strlen(path) > 0 ? rg_basename(path) : NULL;`
`@@ -1713,7 +1719,7 @@ static rg_gui_event_t border_update_cb(rg_gui_option_t *option, rg_gui_event_t e`
`1713`	`1719`	`{`
`1714`	`1720`	`if (event == RG_DIALOG_ENTER)`
`1715`	`1721`	`{`
`1716`		`- char *path = rg_gui_file_picker("Border", RG_BASE_PATH_BORDERS, NULL, true);`
	`1722`	`+ char *path = rg_gui_file_picker("Border", RG_BASE_PATH_BORDERS, NULL, false, true);`
`1717`	`1723`	`if (path != NULL)`
`1718`	`1724`	`{`
`1719`	`1725`	`rg_display_set_border(strlen(path) ? path : NULL);`
Original file line number	Diff line number	Diff line change
`@@ -559,7 +559,7 @@ void app_main()`
`559`	`559`
`560`	`560`	`if (!iwad)`
`561`	`561`	`{`
`562`		`- iwad = rg_gui_file_picker("Select IWAD file", I_DoomExeDir(), is_iwad, false) ?: "";`
	`562`	`+ iwad = rg_gui_file_picker("Select IWAD file", I_DoomExeDir(), is_iwad, false, false) ?: "";`
`563`	`563`	`rg_gui_draw_hourglass(); // Redraw hourglass to indicate loading...`
`564`	`564`	`}`
`565`	`565`