GBA hardware extensions #2251

kaisermg5 · 2021-07-21T17:53:41Z

As we were discussing on discord, here's the draft PR for GBA hardware extensions.
Whats is currently implemented is:

Allow games to access functionality not available in a real GBA console, via reading/writing data to non-existant I/O registers.
One extension called "More RAM" (subject to change), that allows a game to read/write data to a 1MB long memory.
Serialization and deserialization for extensions data.
The ability for the user to enable/disable extensions (disabled by default), individually or globally.
Command line arguments to enable/disable extensions.
Qt ui to enable/disable extensions.

…on that allows a game to access a swap memory it can write to or read from.

…he way parameters are passed.

…o disable extensions. Merged HardwareExtensionsView into SettingsView, and finished it in the process.

…coding styles.

endrift

Lots of stylistic issues/nitpicks, and some questionable design choices need to be addressed before this is mergeable. I haven't given everything a deep look-over yet as a result.

endrift · 2021-07-21T22:35:22Z

include/mgba/core/config.h

+	// Extensions
+	bool hwExtensions;
+	uint16_t hwExtensionsFlags[HWEX_FLAGS_REGISTERS_COUNT];


These should not be in the core opts since they're specific to one core.

Removed them.

endrift · 2021-07-21T22:36:52Z

include/mgba/core/core.h

+	size_t (*hwExtensionsSerialize)(struct mCore*, void** sram);
+	bool (*hwExtensionsDeserialize)(struct mCore*, const void* sram, size_t size);


Would probably make more sense to have a "generic" extdata serialize that you specify via passing in an extdata flag.

endrift · 2021-07-21T22:37:24Z

include/mgba/core/serialize.h

@@ -16,6 +16,7 @@ enum mStateExtdataTag {
 	EXTDATA_SAVEDATA = 2,
 	EXTDATA_CHEATS = 3,
 	EXTDATA_RTC = 4,
+	EXTDATA_HW_EXTENSIONS = 5,


Extensions should probably have a larger ID, I'm trying to reserve low IDs for things that are standard on systems. Maybe 0x80.

Maybe 0x1F? To make it consistent with the SAVESTATE_HW_EXTENSIONS define.
Since flags in mCoreLoadStateNamed and mCoreSaveStateNamed are declared as int, so I shouldn't exceed 32 bits.

The SAVESTATE_HW_EXTENSIONS define is fine--note that there's one for metadata already, which is everything over 0x100, so you don't necessarily need to worry about this one exceeding that bit count.

Fixed. Changed the enum to 0x80 and left the define as it was.

endrift · 2021-07-21T22:38:08Z

include/mgba/feature/commandline.h

+	char hwExtensions;
+	char hwExtensionsFlags[HWEX_EXTENSIONS_COUNT];


See above about configuration. Passing in via a -C flag is probably a better idea, at least for now.

Also removed this.

endrift · 2021-07-21T22:39:29Z

include/mgba/internal/gba/gba.h

@@ -123,6 +124,8 @@ struct GBA {
 	bool debug;
 	char debugString[0x100];
 	GBADebugFlags debugFlags;
+
+	struct GBAHardwareExtensions hwExtensions;


Would probably group this with the other components closer to the beginning.

Fixed. Moved it under the SIO.

src/gba/hardware-extensions.c

endrift · 2021-07-21T22:51:10Z

src/gba/hardware-extensions.c

+        case REG_HWEX_ENABLE_FLAGS_0:
+        case REG_HWEX_ENABLE_FLAGS_1:
+        case REG_HWEX_ENABLE_FLAGS_2:
+        case REG_HWEX_ENABLE_FLAGS_3:
+        case REG_HWEX_ENABLE_FLAGS_4:
+        case REG_HWEX_ENABLE_FLAGS_5: {


What is the purpose of making these registers generic? Why not just have a fixed address per extension?

No particular reason. This way they occupy 1 bit instead of 16. But yeah, I could change it so it works the same as REG_HWEX_ENABLE.

endrift · 2021-07-21T22:51:28Z

src/gba/hardware-extensions.c

+        case REG_HWEX_ENABLE:
+            return 0x1DEA;
+        case REG_HWEX_VERSION:
+            return REG_HWEX_VERSION_VALUE;
+        case REG_HWEX_ENABLE_FLAGS_0:
+        case REG_HWEX_ENABLE_FLAGS_1:
+        case REG_HWEX_ENABLE_FLAGS_2:
+        case REG_HWEX_ENABLE_FLAGS_3:
+        case REG_HWEX_ENABLE_FLAGS_4:
+        case REG_HWEX_ENABLE_FLAGS_5: {
+            uint32_t index = (address - REG_HWEX_ENABLE_FLAGS_0) >> 1;
+            return *GetHwExIOPointer(gba, address) & gba->hwExtensions.userEnabledFlags[index];
+        }
+
+        default:
+            return *GetHwExIOPointer(gba, address);


case statements are unintended, only their content.

src/gba/hardware-extensions.c

… gba extensions.

endrift · 2021-07-22T02:30:08Z

include/mgba/core/serialize.h

@@ -16,6 +16,7 @@ enum mStateExtdataTag {
 	EXTDATA_SAVEDATA = 2,
 	EXTDATA_CHEATS = 3,
 	EXTDATA_RTC = 4,
+	EXTDATA_HW_EXTENSIONS = 5,


The SAVESTATE_HW_EXTENSIONS define is fine--note that there's one for metadata already, which is everything over 0x100, so you don't necessarily need to worry about this one exceeding that bit count.

endrift · 2021-07-22T19:54:35Z

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

@@ -0,0 +1,16 @@
+/* Copyright (c) 2013-2021 Jeffrey Pfau


This file should still be merged into extensions.h--there's no strong reason to keep it separate.

endrift · 2021-07-22T19:55:43Z

src/gba/CMakeLists.txt

@@ -13,6 +13,7 @@ set(SOURCE_FILES
 	cheats/parv3.c
 	core.c
 	dma.c
+	extra/extensions.c


Extras go in the EXTRA_FILES section below, but the feature will need to be able to be ifdef'd out for that to work.

Should I ifdef'd under MINIMAL_CORE or do I create a new define?

…from core options. Renamed said options in the gba core. Renamed "More RAM" to "Extra RAM". Removed flags registers and added one register to specifically enable the extra RAM extension.

…sions serialization functions with more generic extdata serialization functions.

…hree more commands to the extra RAM extension: init, resize and destroy.

kaisermg5 added 18 commits June 29, 2021 22:13

Add .vscode to .gitignore

0051c82

Added a protoype protocol to use hardware extensions. Made an extensi…

cf6d9ef

…on that allows a game to access a swap memory it can write to or read from.

Update with master.

9831a24

Rewrote most of the extensions code to reorganize the IO and change t…

e563a36

…he way parameters are passed.

Hardware extensions code cleanup.

7bba0eb

Fixed bug that allowed to call disabled extensions.

acc10c3

Added command line arguments to enable extensions.

7a12e6a

Added initial hardware extensions serialization support.

36f5879

Organized hardware extensions code a bit.

71e4e6c

Organized hardware extensions code a bit more...

58450e6

Moved some hardcoded stuff to a hardware extensions header file.

e3d7cad

Designed hardware extensions Qt UI. Functionality missing.

6223cd7

Fixed some bugs that happened after refactoring.

3b0b9c3

Made each extension have its own config key. Made command line args t…

77a0db9

…o disable extensions. Merged HardwareExtensionsView into SettingsView, and finished it in the process.

Moved hardware extensions settings into enhancements and redesigned UI.

cedf69f

De-hardcoded some memory regions. And changed an enum to comply with …

b65493b

…coding styles.

Merge branch 'master' of https://github.com/kaisermg5/mgba

165e597

Merge branch 'master' into hardware-extensions

558a008

endrift requested changes Jul 21, 2021

View reviewed changes

kaisermg5 added 2 commits July 22, 2021 02:21

Multiple name changes, moved files and other small changes related to…

ece8c5a

… gba extensions.

Convert spaces indentation to tabs in gab extensions files.

97dac47

endrift requested changes Jul 22, 2021

View reviewed changes

kaisermg5 added 4 commits July 22, 2021 22:49

Removed gba extensions command line args. Also removed their optiond …

274183e

…from core options. Renamed said options in the gba core. Renamed "More RAM" to "Extra RAM". Removed flags registers and added one register to specifically enable the extra RAM extension.

Merged extensions-ids.h with extensions.h. And replaced mCore's exten…

11a7413

…sions serialization functions with more generic extdata serialization functions.

Fixed error on GB, while attempting to deserialize extensions data.

d89678a

Changes to dynamically alloc GBA extensions IO and extra RAM. Added t…

b2c2e55

…hree more commands to the extra RAM extension: init, resize and destroy.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GBA hardware extensions #2251

GBA hardware extensions #2251

kaisermg5 commented Jul 21, 2021

endrift left a comment

endrift Jul 21, 2021

kaisermg5 Jul 23, 2021

endrift Jul 21, 2021

kaisermg5 Jul 25, 2021

endrift Jul 21, 2021

kaisermg5 Jul 22, 2021

endrift Jul 22, 2021

kaisermg5 Jul 25, 2021

endrift Jul 21, 2021

kaisermg5 Jul 23, 2021

endrift Jul 21, 2021

kaisermg5 Jul 22, 2021

endrift Jul 21, 2021

kaisermg5 Jul 22, 2021

kaisermg5 Jul 23, 2021

endrift Jul 21, 2021

kaisermg5 Jul 22, 2021

endrift Jul 22, 2021

endrift Jul 22, 2021

kaisermg5 Jul 25, 2021

endrift Jul 22, 2021

kaisermg5 Jul 23, 2021

		size_t (hwExtensionsSerialize)(struct mCore, void** sram);
		bool (hwExtensionsDeserialize)(struct mCore, const void* sram, size_t size);

		char hwExtensions;
		char hwExtensionsFlags[HWEX_EXTENSIONS_COUNT];

GBA hardware extensions #2251

Are you sure you want to change the base?

GBA hardware extensions #2251

Conversation

kaisermg5 commented Jul 21, 2021

endrift left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment