Ed64 vseries

Makefile

@@ -20,6 +20,8 @@ SRCS = \
 	flashcart/flashcart.c \
 	flashcart/sc64/sc64_ll.c \
 	flashcart/sc64/sc64.c \
+	flashcart/ed64/ed64_ll.c \
+	flashcart/ed64/ed64.c \
 	hdmi/hdmi.c \
 	libs/libspng/spng/spng.c \
 	libs/mini.c/src/mini.c \
@@ -135,4 +137,4 @@ endif
 # test:
 #   TODO: run tests
 
--include $(DEPS)
+-include $(DEPS)

src/flashcart/ed64/README.md

@@ -0,0 +1,9 @@
+This folder allows support for the ED64(P) flashcart when using V series hardware.
+
+Initially, this aims to work when loading the official ED64 OS menu, selecting the N64FlashcartMenu and then loading a ROM from there. This works around needing to load the correct firmware. To automate this, it is possible to set this menu to autoload (at least in the unofficial menu). i.e. You can set this ROM to auto load by placing a file called `autoexec.v64` in the `ED64` folder with the content of the file pointing to the path of this ROM.
+
+Notes: 
+
+* `libcart` seems to use a different base register address `0x08040000`, but official implementation uses `0xA8040000`
+* When loading directly via `ED64\ED64.v64` The ability to load commercial ROM's is broken.
+

src/flashcart/ed64/ed64.c

@@ -0,0 +1,225 @@
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+
+#include <fatfs/ff.h>
+#include <libdragon.h>
+
+#include "utils/fs.h"
+#include "utils/utils.h"
+
+#include "../flashcart_utils.h"
+#include "ed64_ll.h"
+#include "ed64.h"
+
+extern int ed_exit(void);
+
+static flashcart_error_t ed64_init (void) {
+
+    // TODO: partly already done, see https://github.com/DragonMinded/libdragon/blob/4ec469d26b6dc4e308caf3d5b86c2b340b708bbd/src/libcart/cart.c#L1064
+
+    //ed64_ll_unlock_regs();
+
+    // ed64_ll_init(); // FIXME: this causes a crash!
+    // ed64_ll_reset_spx(); // only required if V2+ FW is updating!
+
+    // ed64_ll_set_ram_bank(1); // Seemingly bank 0 (for SRAM 128k) is only supported on V3 and it is not the default.
+
+    // If a V3 or X7 cart is detected (has a battery?), enable RTC, 
+    // ed64_ll_gpio_mode_rtc();
+    // otherwise:
+    // ed64_ll_gpio_mode_io();
+
+
+    return FLASHCART_OK;
+}
+
+static flashcart_error_t ed64_deinit (void) {
+
+    // ed64_ll_gpio_mode_off(); // On V3 or X7, this should be ed64_bios_gpio_mode_rtc() if it is required.
+
+    // For the moment, just use libCart exit.
+    ed_exit();
+
+    return FLASHCART_OK;
+}
+
+static flashcart_error_t ed64_load_rom (char *rom_path, flashcart_progress_callback_t *progress) {
+    FIL fil;
+    UINT br;
+
+    if (f_open(&fil, strip_sd_prefix(rom_path), FA_READ) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    fix_file_size(&fil);
+
+    size_t rom_size = f_size(&fil);
+
+    // FIXME: if the cart is not V3 or X5 or X7, we need to - 128KiB
+    if (rom_size > MiB(64) - KiB(128)) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+
+
+    size_t sdram_size = rom_size;
+
+    size_t chunk_size = MiB(1);
+    for (int offset = 0; offset < sdram_size; offset += chunk_size) {
+        size_t block_size = MIN(sdram_size - offset, chunk_size);
+        if (f_read(&fil, (void *) (ROM_ADDRESS + offset), block_size, &br) != FR_OK) {
+            f_close(&fil);
+            return FLASHCART_ERROR_LOAD;
+        }
+        if (progress) {
+            progress(f_tell(&fil) / (float) (f_size(&fil)));
+        }
+    }
+    if (f_tell(&fil) != sdram_size) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+
+
+    if (f_close(&fil) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    return FLASHCART_OK;
+}
+
+static flashcart_error_t ed64_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset) {
+    FIL fil;
+    UINT br;
+
+    if (f_open(&fil, strip_sd_prefix(file_path), FA_READ) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    fix_file_size(&fil);
+
+    size_t file_size = f_size(&fil) - file_offset;
+
+    // FIXME: if the cart is not V3 or X5 or X7, we need to - 128KiB
+    if (file_size > (MiB(64) - KiB(128) - rom_offset)) {
+        f_close(&fil);
+        return FLASHCART_ERROR_ARGS;
+    }
+
+    if (f_lseek(&fil, file_offset) != FR_OK) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    if (f_read(&fil, (void *) (ROM_ADDRESS + rom_offset), file_size, &br) != FR_OK) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+    if (br != file_size) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    if (f_close(&fil) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    return FLASHCART_OK;
+}
+
+static flashcart_error_t ed64_load_save (char *save_path) {
+    void *address = NULL;
+//     ed64_save_type_t type = ed64_ll_get_save_type();
+
+// //     if (ed64_get_config(CFG_SAVE_TYPE, &type) != ED64_OK) {
+// //         return FLASHCART_ERROR_INT;
+// //     }
+
+// //     switch (type) {
+// //         case SAVE_TYPE_EEPROM_4K:
+// //         case SAVE_TYPE_EEPROM_16K:
+// //             address = (void *) (EEPROM_ADDRESS);
+// //             break;
+// //         case SAVE_TYPE_SRAM:
+// //         case SAVE_TYPE_FLASHRAM:
+// //         case SAVE_TYPE_SRAM_BANKED:
+// //             address = (void *) (SRAM_FLASHRAM_ADDRESS);
+// //             break;
+// //         case SAVE_TYPE_NONE:
+// //         default:
+// //             return FLASHCART_ERROR_ARGS;
+// //     }
+
+    FIL fil;
+    UINT br;
+
+    if (f_open(&fil, strip_sd_prefix(save_path), FA_READ) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    size_t save_size = f_size(&fil);
+
+    if (f_read(&fil, address, save_size, &br) != FR_OK) {
+        f_close(&fil);
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    if (f_close(&fil) != FR_OK) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    if (br != save_size) {
+        return FLASHCART_ERROR_LOAD;
+    }
+
+    return FLASHCART_OK;
+}
+
+static flashcart_error_t ed64_set_save_type (flashcart_save_type_t save_type) {
+    ed64_save_type_t type;
+
+    switch (save_type) {
+        case FLASHCART_SAVE_TYPE_NONE:
+            type = SAVE_TYPE_NONE;
+            break;
+        case FLASHCART_SAVE_TYPE_EEPROM_4K:
+            type = SAVE_TYPE_EEPROM_4K;
+            break;
+        case FLASHCART_SAVE_TYPE_EEPROM_16K:
+            type = SAVE_TYPE_EEPROM_16K;
+            break;
+        case FLASHCART_SAVE_TYPE_SRAM:
+            type = SAVE_TYPE_SRAM;
+            break;
+        case FLASHCART_SAVE_TYPE_SRAM_BANKED:
+        case FLASHCART_SAVE_TYPE_SRAM_128K:
+            type = SAVE_TYPE_SRAM_128K;
+            break;
+        case FLASHCART_SAVE_TYPE_FLASHRAM:
+            type = SAVE_TYPE_FLASHRAM;
+            break;
+        default:
+            return FLASHCART_ERROR_ARGS;
+    }
+
+    ed64_ll_set_save_type(type);
+
+    return FLASHCART_OK;
+}
+
+
+static flashcart_t flashcart_ed64 = {
+    .init = ed64_init,
+    .deinit = ed64_deinit,
+    .load_rom = ed64_load_rom,
+    .load_file = ed64_load_file,
+    .load_save = ed64_load_save,
+    .set_save_type = ed64_set_save_type,
+    .set_save_writeback = NULL,
+};
+
+
+flashcart_t *ed64_get_flashcart (void) {
+    return &flashcart_ed64;
+}

src/flashcart/ed64/ed64.h

@@ -0,0 +1,24 @@
+/**
+ * @file flashcart.h
+ * @brief ED64 Flashcart Utilities
+ * @ingroup flashcart 
+ */
+
+#ifndef FLASHCART_ED64_H__
+#define FLASHCART_ED64_H__
+
+
+#include "../flashcart.h"
+
+
+/**
+ * @addtogroup ed64
+ * @{
+ */
+
+flashcart_t *ed64_get_flashcart (void);
+
+/** @} */ /* ed64 */
+
+
+#endif