GBA hardware extensions

.gitignore

@@ -6,6 +6,7 @@
 /build
 /build-*
 /.vs
+/.vscode
 
 *.a
 *.dylib

include/mgba/core/config.h

@@ -12,6 +12,8 @@ CXX_GUARD_START
 
 #include <mgba-util/configuration.h>
 
+#include <mgba/internal/gba/hardware-extensions-ids.h>
+
 struct mCoreConfig {
 	struct Configuration configTable;
 	struct Configuration defaultsTable;
@@ -58,6 +60,10 @@ struct mCoreOptions {
 
 	bool videoSync;
 	bool audioSync;
+
+	// Extensions
+	bool hwExtensions;
+	uint16_t hwExtensionsFlags[HWEX_FLAGS_REGISTERS_COUNT];
 };
 
 void mCoreConfigInit(struct mCoreConfig*, const char* port);

include/mgba/core/core.h

@@ -160,6 +160,9 @@ struct mCore {
 	void (*startVideoLog)(struct mCore*, struct mVideoLogContext*);
 	void (*endVideoLog)(struct mCore*);
 #endif
+
+	size_t (*hwExtensionsSerialize)(struct mCore*, void** sram);
+	bool (*hwExtensionsDeserialize)(struct mCore*, const void* sram, size_t size);
 };
 
 #if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2

include/mgba/core/serialize.h

@@ -16,6 +16,7 @@ enum mStateExtdataTag {
 	EXTDATA_SAVEDATA = 2,
 	EXTDATA_CHEATS = 3,
 	EXTDATA_RTC = 4,
+	EXTDATA_HW_EXTENSIONS = 5,
 	EXTDATA_META_TIME = 0x101,
 	EXTDATA_MAX
 };
@@ -25,6 +26,7 @@ enum mStateExtdataTag {
 #define SAVESTATE_CHEATS     4
 #define SAVESTATE_RTC        8
 #define SAVESTATE_METADATA   16
+#define SAVESTATE_HW_EXTENSIONS   32
 
 struct mStateExtdataItem {
 	int32_t size;

include/mgba/feature/commandline.h

@@ -14,6 +14,14 @@ CXX_GUARD_START
 
 #include <mgba/debugger/debugger.h>
 
+#include <mgba/internal/gba/hardware-extensions-ids.h>
+
+enum HwExSettingsOverrides {
+	HWEX_DONT_OVERRIDE = 0,
+	HWEX_ENABLE = 1,
+	HWEX_DISABLE = 2,
+};
+
 struct mArguments {
 	char* fname;
 	char* patch;
@@ -29,6 +37,9 @@ struct mArguments {
 	bool debugAtStart;
 	bool showHelp;
 	bool showVersion;
+
+	char hwExtensions;
+	char hwExtensionsFlags[HWEX_EXTENSIONS_COUNT];
 };
 
 struct mCoreConfig;

include/mgba/internal/gba/gba.h

@@ -18,6 +18,7 @@ CXX_GUARD_START
 #include <mgba/internal/gba/audio.h>
 #include <mgba/internal/gba/sio.h>
 #include <mgba/internal/gba/timer.h>
+#include <mgba/internal/gba/hardware-extensions.h>
 
 #define GBA_ARM7TDMI_FREQUENCY 0x1000000U
 
@@ -123,6 +124,8 @@ struct GBA {
 	bool debug;
 	char debugString[0x100];
 	GBADebugFlags debugFlags;
+
+	struct GBAHardwareExtensions hwExtensions;
 };
 
 struct GBACartridge {

include/mgba/internal/gba/hardware-extensions-ids.h

@@ -0,0 +1,16 @@
+/* Copyright (c) 2021 Jeffrey Pfau
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+#ifndef HARDWARE_EXTENSIONS_IDS_H
+#define HARDWARE_EXTENSIONS_IDS_H
+
+enum HARDWARE_EXTENSIONS_IDS {
+    HWEX_ID_MORE_RAM = 0,
+    HWEX_EXTENSIONS_COUNT
+};
+
+#define HWEX_FLAGS_REGISTERS_COUNT ((HWEX_EXTENSIONS_COUNT / 16) + (HWEX_EXTENSIONS_COUNT % 16 ? 1 : 0))
+
+#endif

include/mgba/internal/gba/hardware-extensions.h

@@ -0,0 +1,56 @@
+/* Copyright (c) 2021 Jeffrey Pfau
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+#ifndef HARDWARE_EXTENSIONS_H
+#define HARDWARE_EXTENSIONS_H
+
+#include <mgba-util/common.h>
+
+#include <mgba/core/log.h>
+#include <mgba/core/timing.h>
+
+#include <mgba/internal/gba/io.h>
+#include <mgba/internal/gba/hardware-extensions-ids.h>
+
+
+#define REG_HWEX_VERSION_VALUE HWEX_EXTENSIONS_COUNT
+#define HWEX_MORE_RAM_SIZE 0x100000 // 1 MB
+
+struct GBAHardwareExtensions {
+    bool enabled;
+    bool userEnabled;
+    uint16_t userEnabledFlags[HWEX_FLAGS_REGISTERS_COUNT];
+
+    // IO:
+    uint32_t memory[(REG_HWEX_END - REG_HWEX_ENABLE) / 2];
+
+    // Other data
+    uint32_t moreRam[HWEX_MORE_RAM_SIZE / sizeof(uint32_t)];
+};
+
+
+struct GBAHardwareExtensionsState {
+    uint32_t enabled; // boolean
+    uint32_t version;
+
+    // IO:
+    uint32_t memory[128];
+
+    // Other data
+    uint32_t moreRam[HWEX_MORE_RAM_SIZE / sizeof(uint32_t)];
+};
+
+
+struct GBA;
+void GBAHardwareExtensionsInit(struct GBAHardwareExtensions* hw);
+uint16_t GBAHardwareExtensionsIORead(struct GBA* gba, uint32_t address);
+uint32_t GBAHardwareExtensionsIORead32(struct GBA* gba, uint32_t address);
+void GBAHardwareExtensionsIOWrite8(struct GBA* gba, uint32_t address, uint8_t value);
+void GBAHardwareExtensionsIOWrite(struct GBA* gba, uint32_t address, uint16_t value);
+void GBAHardwareExtensionsIOWrite32(struct GBA* gba, uint32_t address, uint32_t value);
+bool GBAHardwareExtensionsSerialize(struct GBA* gba, struct GBAHardwareExtensionsState* state);
+bool GBAHardwareExtensionsDeserialize(struct GBA* gba, const struct GBAHardwareExtensionsState* state, size_t size);
+
+#endif

include/mgba/internal/gba/io.h

@@ -157,6 +157,31 @@ enum GBAIORegisters {
 	REG_DEBUG_STRING = 0xFFF600,
 	REG_DEBUG_FLAGS = 0xFFF700,
 	REG_DEBUG_ENABLE = 0xFFF780,
+
+	// Extensions
+	REG_HWEX_ENABLE = 0x400A00,
+	REG_HWEX_VERSION = 0x400A02,
+	REG_HWEX_ENABLE_FLAGS_0 = 0x400A04,
+	REG_HWEX_ENABLE_FLAGS_1 = 0x400A06,
+	REG_HWEX_ENABLE_FLAGS_2 = 0x400A08,
+	REG_HWEX_ENABLE_FLAGS_3 = 0x400A0A,
+	REG_HWEX_ENABLE_FLAGS_4 = 0x400A0C,
+	REG_HWEX_ENABLE_FLAGS_5 = 0x400A0E,
+
+	// More RAM
+	REG_HWEX0_CNT = 0x400A10,
+	REG_HWEX0_RET_CODE = 0x400A12,
+	REG_HWEX0_P0_LO = 0x400A14,	// command
+	REG_HWEX0_P0_HI = 0x400A16,
+	REG_HWEX0_P1_LO = 0x400A18,	// index
+	REG_HWEX0_P1_HI = 0x400A1A,
+	REG_HWEX0_P2_LO = 0x400A1C,	// data pointer
+	REG_HWEX0_P2_HI = 0x400A1E,
+	REG_HWEX0_P3_LO = 0x400A20,	// size
+	REG_HWEX0_P3_HI = 0x400A22,
+
+	REG_HWEX_END = 0x400A24,
+
 };
 
 mLOG_DECLARE_CATEGORY(GBA_IO);

src/core/config.c

@@ -440,6 +440,29 @@ void mCoreConfigMap(const struct mCoreConfig* config, struct mCoreOptions* opts)
 	_lookupCharValue(config, "screenshotPath", &opts->screenshotPath);
 	_lookupCharValue(config, "patchPath", &opts->patchPath);
 	_lookupCharValue(config, "cheatsPath", &opts->cheatsPath);
+
+	_lookupIntValue(config, "hwExtensions", &fakeBool);
+	opts->hwExtensions = fakeBool;
+
+	const char hexDigits[] = "0123456789ABCDEF";
+	char hwExtensionsFlagsKey[] = "hwExtensionsFlags_XXXX";
+	for (size_t index = 0; index <= (HWEX_EXTENSIONS_COUNT >> 4); index++) {
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 3] = hexDigits[index & 0xF];
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 4] = hexDigits[(index >> 4) & 0xF];
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 5] = hexDigits[(index >> 8) & 0xF];
+
+		for (size_t offset = 0; offset < 0x10 && ((index << 4) + offset) < HWEX_EXTENSIONS_COUNT; offset++) {
+			uint16_t bitFlag = (1 << offset);
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 2] = hexDigits[offset];
+			if (_lookupIntValue(config, hwExtensionsFlagsKey, &fakeBool)) {
+				if (fakeBool) {
+					opts->hwExtensionsFlags[index] |= bitFlag;
+				} else {
+					opts->hwExtensionsFlags[index] &= 0xFFFF ^ bitFlag;
+				}
+			}
+		}
+	}
 }
 
 void mCoreConfigLoadDefaults(struct mCoreConfig* config, const struct mCoreOptions* opts) {
@@ -465,6 +488,21 @@ void mCoreConfigLoadDefaults(struct mCoreConfig* config, const struct mCoreOptio
 	ConfigurationSetIntValue(&config->defaultsTable, 0, "lockIntegerScaling", opts->lockIntegerScaling);
 	ConfigurationSetIntValue(&config->defaultsTable, 0, "resampleVideo", opts->resampleVideo);
 	ConfigurationSetIntValue(&config->defaultsTable, 0, "suspendScreensaver", opts->suspendScreensaver);
+
+	ConfigurationSetIntValue(&config->defaultsTable, 0, "hwExtensions", opts->hwExtensions);
+
+	const char hexDigits[] = "0123456789ABCDEF";
+	char hwExtensionsFlagsKey[] = "hwExtensionsFlags_XXXX";
+	for (size_t index = 0; index <= HWEX_EXTENSIONS_COUNT; index++) {
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 3] = hexDigits[index & 0xF];
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 4] = hexDigits[(index >> 4) & 0xF];
+		hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 5] = hexDigits[(index >> 8) & 0xF];
+
+		for (size_t offset = 0; offset < 0x10 && ((index << 4) + offset) < HWEX_EXTENSIONS_COUNT; offset++) {
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 2] = hexDigits[offset];
+			ConfigurationSetIntValue(&config->defaultsTable, 0, hwExtensionsFlagsKey, (opts->hwExtensionsFlags[index] & (1 << offset)) != 0);
+		}
+	}
 }
 
 static void _configEnum(const char* key, const char* value, void* user) {

src/core/serialize.c

@@ -421,6 +421,18 @@ bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags) {
 			mStateExtdataPut(&extdata, EXTDATA_RTC, &item);
 		}
 	}
+	if ((true || flags & SAVESTATE_HW_EXTENSIONS) && core->hwExtensionsSerialize) {
+		void* sram = NULL;
+		size_t size = core->hwExtensionsSerialize(core, &sram);
+		if (size) {
+			struct mStateExtdataItem item = {
+				.size = size,
+				.data = sram,
+				.clean = free
+			};
+			mStateExtdataPut(&extdata, EXTDATA_HW_EXTENSIONS, &item);
+		}
+	}
 #ifdef USE_PNG
 	if (!(flags & SAVESTATE_SCREENSHOT)) {
 #else
@@ -537,6 +549,10 @@ bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags) {
 			core->rtc.d.deserialize(&core->rtc.d, &item);
 		}
 	}
+	if ((true || flags & SAVESTATE_HW_EXTENSIONS) && core->hwExtensionsDeserialize && mStateExtdataGet(&extdata, EXTDATA_HW_EXTENSIONS, &item)) {
+		mLOG(SAVESTATE, INFO, "Loading hardware extensions");
+		core->hwExtensionsDeserialize(core, item.data, item.size);
+	}
 	mStateExtdataDeinit(&extdata);
 	return success;
 }

src/feature/commandline.c

@@ -27,6 +27,9 @@
 	"  -6               6x viewport\n" \
 	"  -f               Start full-screen"
 
+#define HWEX_ARGS_OFFSET 0x1002
+#define HWEX_ARGS_NO_OFFSET (HWEX_ARGS_OFFSET + HWEX_EXTENSIONS_COUNT)
+
 static const struct option _options[] = {
 	{ "bios",      required_argument, 0, 'b' },
 	{ "cheats",    required_argument, 0, 'c' },
@@ -42,6 +45,13 @@ static const struct option _options[] = {
 	{ "savestate", required_argument, 0, 't' },
 	{ "patch",     required_argument, 0, 'p' },
 	{ "version",   no_argument, 0, '\0' },
+	// Extensions
+	{ "hw-extensions", no_argument, 0, HWEX_ARGS_OFFSET - 4 },
+	{ "no-hw-extensions", no_argument, 0, HWEX_ARGS_OFFSET - 3 },
+	{ "hwex-all", no_argument, 0, HWEX_ARGS_OFFSET - 2 },
+	{ "hwex-none", no_argument, 0, HWEX_ARGS_OFFSET - 1 },
+	{ "hwex-more-ram", no_argument, 0, HWEX_ARGS_OFFSET + HWEX_ID_MORE_RAM },
+	{ "no-hwex-more-ram", no_argument, 0, HWEX_ARGS_NO_OFFSET + HWEX_ID_MORE_RAM },
 	{ 0, 0, 0, 0 }
 };
 
@@ -135,6 +145,32 @@ bool parseArguments(struct mArguments* args, int argc, char* const* argv, struct
 		case 't':
 			args->savestate = strdup(optarg);
 			break;
+
+		// Extensions
+		case HWEX_ARGS_OFFSET - 4:
+			// enable extensions
+			args->hwExtensions = HWEX_ENABLE;
+			break;
+		case HWEX_ARGS_OFFSET - 3:
+			// enable extensions
+			args->hwExtensions = HWEX_DISABLE;
+			break;
+		case HWEX_ARGS_OFFSET - 2:
+			// enable all extensions
+			memset(args->hwExtensionsFlags, HWEX_ENABLE, sizeof(args->hwExtensionsFlags));
+			break;
+		case HWEX_ARGS_OFFSET - 1:
+			// disable all extensions
+			memset(args->hwExtensionsFlags, HWEX_DISABLE, sizeof(args->hwExtensionsFlags));
+			break;
+		case HWEX_ARGS_OFFSET + HWEX_ID_MORE_RAM:
+			// enable 1 extension
+			args->hwExtensionsFlags[ch - HWEX_ARGS_OFFSET] = HWEX_ENABLE;
+			break;
+		case HWEX_ARGS_NO_OFFSET + HWEX_ID_MORE_RAM:
+			// disable 1 extension
+			args->hwExtensionsFlags[ch - HWEX_ARGS_OFFSET] = HWEX_ENABLE;
+			break;
 		default:
 			if (subparser) {
 				if (!subparser->parse(subparser, ch, optarg)) {
@@ -166,6 +202,20 @@ void applyArguments(const struct mArguments* args, struct mSubParser* subparser,
 	if (args->bios) {
 		mCoreConfigSetOverrideValue(config, "bios", args->bios);
 	}
+	if (args->hwExtensions) {
+		mCoreConfigSetOverrideIntValue(config, "hwExtensions", args->hwExtensions == HWEX_ENABLE);
+	}
+	const char hexDigits[] = "0123456789ABCDEF";
+	char hwExtensionsFlagsKey[] = "hwExtensionsFlags_XXXX";
+	for (size_t i = 0; i < (sizeof(args->hwExtensionsFlags) / sizeof(args->hwExtensionsFlags[0])); i++) {
+		if (args->hwExtensionsFlags[i]) {
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 2] = hexDigits[i & 0xF];
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 3] = hexDigits[(i >> 4) & 0xF];
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 4] = hexDigits[(i >> 8) & 0xF];
+			hwExtensionsFlagsKey[sizeof(hwExtensionsFlagsKey) - 5] = hexDigits[(i >> 12) & 0xF];
+			mCoreConfigSetOverrideIntValue(config, hwExtensionsFlagsKey, args->hwExtensionsFlags[i] == HWEX_ENABLE);
+		}
+	}
 	HashTableEnumerate(&args->configOverrides, _tableApply, config);
 	if (subparser) {
 		subparser->apply(subparser, config);
@@ -248,6 +298,15 @@ void usage(const char* arg0, const char* extraOptions) {
 	puts("  -p, --patch FILE           Apply a specified patch file when running");
 	puts("  -s, --frameskip N          Skip every N frames");
 	puts("  --version                  Print version and exit");
+
+	puts("\nHardware extensions options:");
+	puts("  --hw-extensions            Enable hardware extensions");
+	puts("  --no-hw-extensions         Disable hardware extensions");
+	puts("  --hwex-all                 Enable all hardware extensions");
+	puts("  --hwex-none                Disable all hardware extensions");
+	puts("  --hwex-more-ram            Enable hardware extension \"More RAM\"");
+	puts("  --no-hwex-more-ram         Disable hardware extension \"More RAM\"");
+
 	if (extraOptions) {
 		puts(extraOptions);
 	}

src/gba/CMakeLists.txt

@@ -14,6 +14,7 @@ set(SOURCE_FILES
 	core.c
 	dma.c
 	gba.c
+	hardware-extensions.c
 	hle-bios.c
 	input.c
 	io.c