Add button remapping

Closes #1787

Author: RocketRobz

retail/arm9/include/configuration.h

@@ -67,6 +67,14 @@ typedef struct configuration {
 	// int colorMode;
 	u8 romRead_LED;
 	u8 dmaRomRead_LED;
+	u8 remappedKeyA;
+	u8 remappedKeyB;
+	u8 remappedKeySELECT;
+	u8 remappedKeySTART;
+	u8 remappedKeyR;
+	u8 remappedKeyL;
+	u8 remappedKeyX;
+	u8 remappedKeyY;
 	bool asyncCardRead;
 	int cardReadDMA;
 	bool boostCpu;

retail/arm9/source/conf_sd.cpp

@@ -409,6 +409,16 @@ static void load_conf(configuration* conf, const char* fn) {
 	// DMA ROM read LED
 	conf->dmaRomRead_LED = strtol(config_file.fetch("NDS-BOOTSTRAP", "DMA_ROMREAD_LED", "0").c_str(), NULL, 0);
 
+	// Remapped buttons
+	conf->remappedKeyA = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_A", "0").c_str(), NULL, 0);
+	conf->remappedKeyB = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_B", "1").c_str(), NULL, 0);
+	conf->remappedKeySELECT = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_SELECT", "2").c_str(), NULL, 0);
+	conf->remappedKeySTART = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_START", "3").c_str(), NULL, 0);
+	conf->remappedKeyR = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_R", "8").c_str(), NULL, 0);
+	conf->remappedKeyL = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_L", "9").c_str(), NULL, 0);
+	conf->remappedKeyX = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_X", "10").c_str(), NULL, 0);
+	conf->remappedKeyY = strtol(config_file.fetch("NDS-BOOTSTRAP", "REMAPPED_KEY_Y", "11").c_str(), NULL, 0);
+
 	// get the gamecode
 	FILE* romFile = fopen(conf->ndsPath, "rb");
 	char gameTid[5];

retail/arm9/source/nds_loader_arm9.c

@@ -307,6 +307,14 @@ int runNds(u32 cluster, u32 saveCluster, u32 donorTwlCluster, /* u32 gbaCluster,
 	loader->language                    = conf->language;
 	loader->region                      = conf->region;
 	loader->dsiMode                     = conf->dsiMode; // SDK 5
+	loader->remappedKeyA                = conf->remappedKeyA;
+	loader->remappedKeyB                = conf->remappedKeyB;
+	loader->remappedKeySELECT           = conf->remappedKeySELECT;
+	loader->remappedKeySTART            = conf->remappedKeySTART;
+	loader->remappedKeyR                = conf->remappedKeyR;
+	loader->remappedKeyL                = conf->remappedKeyL;
+	loader->remappedKeyX                = conf->remappedKeyX;
+	loader->remappedKeyY                = conf->remappedKeyY;
 	loader->valueBits2                  = conf->valueBits2;
 	loader->donorSdkVer                 = conf->donorSdkVer;
 	loader->patchMpuRegion              = conf->patchMpuRegion;

retail/bootloader/Makefile

@@ -37,7 +37,7 @@ CFLAGS	:=	-g -Wall -O2\
 			-ffast-math \
 			$(ARCH)
 
-CFLAGS	+=	$(INCLUDE) -DARM7 -D_NO_SDMMC -DB4DS -DLOADERTYPE0 -std=gnu99
+CFLAGS	+=	$(INCLUDE) -DARM7 -D_NO_SDMMC -DB4DS -DBUILDFATTABLE -DLOADERTYPE0 -std=gnu99
 
 ASFLAGS	:=	-g $(ARCH) $(INCLUDE)
 LDFLAGS	=	-nostartfiles -T $(TOPDIR)/load.ld -g $(ARCH) -Wl,--nmagic -Wl,-Map,$(TARGET).map

retail/bootloader/include/patch.h

@@ -151,7 +151,8 @@ u32 patchCardNdsArm9(
 	const tNDSHeader* ndsHeader,
 	const module_params_t* moduleParams,
 	u32 patchMpuRegion,
-	const bool usesCloneboot
+	const bool usesCloneboot,
+	const bool buttonsRemapped
 );
 void patchCardNdsArm9Cont(
 	cardengineArm9* ce9,
@@ -162,7 +163,8 @@ u32 patchCardNdsArm7(
 	cardengineArm7* ce7,
 	tNDSHeader* ndsHeader,
 	const module_params_t* moduleParams,
-	u32 saveFileCluster
+	u32 saveFileCluster,
+	const bool buttonsRemapped
 );
 u32 patchCardNds(
 	cardengineArm7* ce7,
@@ -171,6 +173,7 @@ u32 patchCardNds(
 	const module_params_t* moduleParams,
 	u32 patchMpuRegion,
 	const bool usesCloneboot,
+	const bool buttonsRemapped,
 	u32 saveFileCluster,
 	u32 saveSize
 );

retail/bootloader/source/arm7/hook_arm7.c

@@ -208,6 +208,15 @@ int hookNdsRetailArm7(
 
 	const bool laterSdk = ((moduleParams->sdk_version >= 0x2008000 && moduleParams->sdk_version != 0x2012774) || moduleParams->sdk_version == 0x20029A8);
 
+	extern u8 remappedKeyA;
+	extern u8 remappedKeyB;
+	extern u8 remappedKeySELECT;
+	extern u8 remappedKeySTART;
+	extern u8 remappedKeyR;
+	extern u8 remappedKeyL;
+	extern u8 remappedKeyX;
+	extern u8 remappedKeyY;
+
 	u32 cheatEngineAddr = CHEAT_ENGINE_LOCATION_B4DS;
 	if (!extendedMemory && strncmp(romTid, "CLJ", 3) == 0) { // Mario & Luigi: Bowser's Inside Story
 		cheatEngineAddr = 0x02002000;
@@ -241,6 +250,14 @@ int hookNdsRetailArm7(
 	if (strcmp(romTid, "AKYP") == 0) { // Etrian Odyssey (EUR)
 		ce7->languageAddr = (u32*)0x020DC5DC;
 	}
+	ce7->remappedKeyA            = remappedKeyA;
+	ce7->remappedKeyB            = remappedKeyB;
+	ce7->remappedKeySELECT       = remappedKeySELECT;
+	ce7->remappedKeySTART        = remappedKeySTART;
+	ce7->remappedKeyR            = remappedKeyR;
+	ce7->remappedKeyL            = remappedKeyL;
+	ce7->remappedKeyX            = remappedKeyX;
+	ce7->remappedKeyY            = remappedKeyY;
 	ce7->RumblePakType           = RumblePakType;
 
 	*vblankHandler = ce7->patches->vblankHandler;

retail/bootloader/source/arm7/load_crt0.s

@@ -76,6 +76,14 @@
 	.global language
 	.global region
 	.global dsiMode
+	.global remappedKeyA
+	.global remappedKeyB
+	.global remappedKeySELECT
+	.global remappedKeySTART
+	.global remappedKeyR
+	.global remappedKeyL
+	.global remappedKeyX
+	.global remappedKeyY
 	.global valueBits2
 	.global donorSdkVer
 	.global consoleModel
@@ -210,6 +218,22 @@ region:
 	.byte	0
 dsiMode:
 	.byte	0
+remappedKeyA:
+	.byte	0
+remappedKeyB:
+	.byte	1
+remappedKeySELECT:
+	.byte	2
+remappedKeySTART:
+	.byte	3
+remappedKeyR:
+	.byte	8
+remappedKeyL:
+	.byte	9
+remappedKeyX:
+	.byte	10
+remappedKeyY:
+	.byte	11
 valueBits2:
 	.byte	0
 donorSdkVer:

retail/bootloader/source/arm7/main.arm7.c

@@ -116,6 +116,14 @@ extern u32 patchMpuSize;
 extern u8 patchMpuRegion;
 extern u8 language;
 extern s8 region;
+extern u8 remappedKeyA;
+extern u8 remappedKeyB;
+extern u8 remappedKeySELECT;
+extern u8 remappedKeySTART;
+extern u8 remappedKeyR;
+extern u8 remappedKeyL;
+extern u8 remappedKeyX;
+extern u8 remappedKeyY;
 extern u8 donorSdkVer;
 extern u8 soundFreq;
 extern char version[20];
@@ -285,7 +293,7 @@ static void resetMemory_ARM7(void) {
 	memset_addrs_arm7(0x03800000 - 0x8000, 0x03800000 + 0x10000);
 	toncset((u32*)0x02380000, 0, 0x38000);		// clear part of EWRAM - except before 0x023B8000, which has the DSiWare ROM's arm9i code, and 0x023BF000, which has the bootloader arm9 code
 	toncset((u32*)0x023C0000, 0, 0x20000);
-	toncset((u32*)0x023F0000, 0, 0xD000);
+	toncset((u32*)0x023F0000, 0, 0xCE00);
 	toncset((u32*)0x023FE000, 0, 0x400);
 	toncset((u32*)0x023FF000, 0, 0x1000);
 
@@ -1376,15 +1384,15 @@ int arm7_main(void) {
 		overlayPatch = true; // Allow overlay patching for SM64DS ROM hacks (ex. Mario's Holiday)
 	}
 
+	tonccpy((u8*)CARDENGINE_ARM7_LOCATION, (u8*)CARDENGINE_ARM7_LOCATION_BUFFERED, 0x1200);
+	toncset((u8*)CARDENGINE_ARM7_LOCATION_BUFFERED, 0, 0x1200);
+
 	ce9Location = *(u32*)CARDENGINE_ARM9_LOCATION_BUFFERED;
 	ce9Alt = (ce9Location == CARDENGINE_ARM9_LOCATION_DLDI_ALT || ce9Location == CARDENGINE_ARM9_LOCATION_DLDI_ALT2);
 	// const bool ce9NotInHeap = (ce9Alt || ce9Location == CARDENGINE_ARM9_LOCATION_DLDI_START);
 	tonccpy((u32*)ce9Location, (u32*)CARDENGINE_ARM9_LOCATION_BUFFERED, ce9Alt ? 0x2800 : 0x3800);
 	toncset((u32*)0x023E0000, 0, 0x10000);
 
-	tonccpy((u8*)CARDENGINE_ARM7_LOCATION, (u8*)CARDENGINE_ARM7_LOCATION_BUFFERED, 0x1000);
-	toncset((u8*)CARDENGINE_ARM7_LOCATION_BUFFERED, 0, 0x1000);
-
 	aFile musicsFile;
 	getFileFromCluster(&musicsFile, musicCluster);
 	if (((accessControl & BIT(4)) || arm7mbk == 0x080037C0) && musicCluster != 0) {
@@ -1597,6 +1605,7 @@ int arm7_main(void) {
 		moduleParams,
 		1,
 		usesCloneboot,
+		(remappedKeyA != 0) || (remappedKeyB != 1) || (remappedKeySELECT != 2) || (remappedKeySTART != 3) || (remappedKeyR != 8) || (remappedKeyL != 9) || (remappedKeyX != 10) || (remappedKeyY != 11),
 		saveFileCluster,
 		saveSize
 	);
@@ -1640,7 +1649,7 @@ int arm7_main(void) {
 		errorOutput();
 	}
 
-	toncset((u32*)0x0380C000, 0, 0x2780);
+	toncset((u32*)0x0380C000, 0, 0x2380);
 
 	errorCode = hookNdsRetailArm7(
 		(cardengineArm7*)CARDENGINE_ARM7_LOCATION,

retail/bootloader/source/arm7/patch_arm7.c

@@ -320,7 +320,7 @@ static void patchSleepMode(const tNDSHeader* ndsHeader) {
 }
 
 
-static void patchSleepInputWrite(const tNDSHeader* ndsHeader, const module_params_t* moduleParams) {
+static void patchSleepInputWrite(cardengineArm7* ce7, const tNDSHeader* ndsHeader, const module_params_t* moduleParams, const bool useRelocSrc) {
 	u32* offset = patchOffsetCache.sleepInputWriteOffset;
 	if (!patchOffsetCache.sleepInputWriteOffset) {
 		offset = findSleepInputWriteOffset(ndsHeader, moduleParams);
@@ -332,15 +332,54 @@ static void patchSleepInputWrite(const tNDSHeader* ndsHeader, const module_param
 		return;
 	}
 
+	const bool isArm = (*offset == 0x13A04902 || *offset == 0x11A05004);
+
 	if (!sleepMode) {
-		if (*offset == 0x13A04902 || *offset == 0x11A05004) {
+		if (isArm) {
 			*offset = 0xE1A00000; // nop
 		} else {
 			u16* offsetThumb = (u16*)offset;
 			*offsetThumb = 0x46C0; // nop
 		}
 	}
 
+	if (useRelocSrc) {
+		bool found = false;
+		u32 offsetAdjust = (u32)offset;
+		if (isArm) {
+			for (int i = 0; i < 6; i++) {
+				offsetAdjust += 4;
+				if (*(u32*)offsetAdjust == 0xE1C010B0) {
+					found = true;
+					break;
+				}
+			}
+
+			if (found) {
+				const u32 srcAddr = (u32)offsetAdjust - vAddrOfRelocSrc + (*(u32*)0x02FFE1A0==0x080037C0 ? 0x37C0000 : 0x37F8000);
+				*(u32*)offsetAdjust = generateA7Instr(srcAddr, (u32)ce7->patches->patchKeyInputs);
+			}
+		} else {
+			for (int i = 0; i < 10; i++) {
+				offsetAdjust += 2;
+				if (*(u16*)offsetAdjust == 0x8001) {
+					found = true;
+					break;
+				}
+			}
+
+			if (found) {
+				*(u16*)offsetAdjust = 0x46C0; // nop
+				offsetAdjust += 2;
+				ce7->patches->patchKeyInputsThumb[3] = *(u16*)offsetAdjust;
+				*(u16*)offsetAdjust = 0x4B00; // ldr r3, =patchKeyInputsThumb
+				*(u16*)(offsetAdjust + 2) = 0x4718; // bx r3
+				*(u32*)(offsetAdjust + 4) = (u32)ce7->patches->patchKeyInputsThumb;
+				*(u32*)(offsetAdjust + 4) += 1;
+			}
+		}
+	}
+
 	dbg_printf("Sleep input write location : ");
 	dbg_hexa((u32)offset);
 	dbg_printf("\n\n");
@@ -458,7 +497,8 @@ u32 patchCardNdsArm7(
 	cardengineArm7* ce7,
 	tNDSHeader* ndsHeader,
 	const module_params_t* moduleParams,
-	u32 saveFileCluster
+	u32 saveFileCluster,
+	const bool buttonsRemapped
 ) {
 	arm7newUnitCode = ndsHeader->unitCode;
 	newArm7binarySize = ndsHeader->arm7binarySize;
@@ -524,7 +564,6 @@ u32 patchCardNdsArm7(
 	patchPostBoot(ndsHeader);
 
 	patchSleepMode(ndsHeader);
-	patchSleepInputWrite(ndsHeader, moduleParams);
 
 	patchRamClear(ndsHeader, moduleParams);
 
@@ -548,6 +587,7 @@ u32 patchCardNdsArm7(
 	}
 
 	if (a7GetReloc(ndsHeader, moduleParams)) {
+		patchSleepInputWrite(ce7, ndsHeader, moduleParams, buttonsRemapped);
 		u32 saveResult = 0;
 		// Save Relocation Switch
 		// Only when saveRelocation is turning off(FLASE) and GameCodeMatch is matching(TRUE),
@@ -603,6 +643,8 @@ u32 patchCardNdsArm7(
 		if (!saveResult) {
 			patchOffsetCache.savePatchType = 0;
 		}
+	} else {
+		patchSleepInputWrite(ce7, ndsHeader, moduleParams, false);
 	}
 
 	if (strcmp(romTid, "UBRP") == 0) {

retail/bootloader/source/arm7/patch_arm9.c

@@ -1283,6 +1283,29 @@ void patchHiHeapPointer(cardengineArm9* ce9, const module_params_t* moduleParams
     dbg_printf(!(nandAccess && extendedMemory) ? "Hi Heap Shrink Successful\n\n" : "Hi Heap Grow Successful\n\n");
 }
 
+void patchKeyInputs(const tNDSHeader* ndsHeader, const module_params_t* moduleParams) {
+	const u32 signature = 0x04000130;
+	const u32 signatureHeader = isSdk5(moduleParams) ? 0x02FFFFA8 : 0x027FFFA8;
+	const u32 newOffset = isSdk5(moduleParams) ? 0x02FFFF78 : 0x027FFF78;
+
+	u32* offset = ndsHeader->arm9destination;
+	for (int i = 0; i < ndsHeader->arm9binarySize/4; i++) {
+		if (*offset == signature) {
+			if (offset[-2] == signatureHeader || offset[-1] == signatureHeader || offset[1] == signatureHeader || offset[2] == signatureHeader) {
+				*offset = newOffset;
+
+				dbg_printf("KEYINPUT found: ");
+				dbg_hexa((u32)offset);
+				dbg_printf("\n");
+			}
+		}
+		offset++;
+	}
+	dbg_printf("\n");
+
+	*(u16*)newOffset = 0x3FF;
+}
+
 u32 relocateBssPart(const tNDSHeader* ndsHeader, u32 bssEnd, u32 bssPartStart, u32 bssPartEnd, u32 newPartStart) {
 	extern u32 iUncompressedSize;
 
@@ -2705,7 +2728,7 @@ static void operaRamPatch(void) {
 	}
 }
 
-u32 patchCardNdsArm9(cardengineArm9* ce9, const tNDSHeader* ndsHeader, const module_params_t* moduleParams, u32 patchMpuRegion, const bool usesCloneboot) {
+u32 patchCardNdsArm9(cardengineArm9* ce9, const tNDSHeader* ndsHeader, const module_params_t* moduleParams, u32 patchMpuRegion, const bool usesCloneboot, const bool buttonsRemapped) {
 	bool usesThumb;
 	int readType;
 	int sdk5ReadType; // SDK 5
@@ -2775,6 +2798,10 @@ u32 patchCardNdsArm9(cardengineArm9* ce9, const tNDSHeader* ndsHeader, const mod
 
 	patchHiHeapPointer(ce9, moduleParams, ndsHeader);
 
+	if (buttonsRemapped) {
+		patchKeyInputs(ndsHeader, moduleParams);
+	}
+
 	if (isPawsAndClaws(ndsHeader)) {
 		patchCardId(ce9, ndsHeader, moduleParams, false, NULL); // Patch card ID first
 	}