src/gba/overrides.c (view raw)
1/* Copyright (c) 2013-2015 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include <mgba/internal/gba/overrides.h>
7
8#include <mgba/internal/gba/gba.h>
9#include <mgba/internal/gba/hardware.h>
10
11#include <mgba-util/configuration.h>
12
13static const struct GBACartridgeOverride _overrides[] = {
14 // Advance Wars
15 { "AWRE", SAVEDATA_FLASH512, HW_NONE, 0x8038810, false },
16 { "AWRP", SAVEDATA_FLASH512, HW_NONE, 0x8038810, false },
17
18 // Advance Wars 2: Black Hole Rising
19 { "AW2E", SAVEDATA_FLASH512, HW_NONE, 0x8036E08, false },
20 { "AW2P", SAVEDATA_FLASH512, HW_NONE, 0x803719C, false },
21
22 // Boktai: The Sun is in Your Hand
23 { "U3IJ", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
24 { "U3IE", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
25 { "U3IP", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
26
27 // Boktai 2: Solar Boy Django
28 { "U32J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
29 { "U32E", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
30 { "U32P", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
31
32 // Crash Bandicoot 2 - N-Tranced
33 { "AC8J", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
34 { "AC8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
35 { "AC8P", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
36
37 // Dragon Ball Z - The Legacy of Goku
38 { "ALGP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
39
40 // Dragon Ball Z - The Legacy of Goku II
41 { "ALFJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
42 { "ALFE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
43 { "ALFP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
44
45 // Dragon Ball Z - Taiketsu
46 { "BDBE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
47 { "BDBP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
48
49 // Drill Dozer
50 { "V49J", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE, false },
51 { "V49E", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE, false },
52
53 // e-Reader
54 { "PEAJ", SAVEDATA_FLASH1M, HW_EREADER, IDLE_LOOP_NONE },
55 { "PSAJ", SAVEDATA_FLASH1M, HW_EREADER, IDLE_LOOP_NONE },
56 { "PSAE", SAVEDATA_FLASH1M, HW_EREADER, IDLE_LOOP_NONE },
57
58 // Final Fantasy Tactics Advance
59 { "AFXE", SAVEDATA_FLASH512, HW_NONE, 0x8000428, false },
60
61 // F-Zero - Climax
62 { "BFTJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
63
64 // Iridion II
65 { "AI2E", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
66 { "AI2P", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
67
68 // Golden Sun: The Lost Age
69 { "AGFE", SAVEDATA_FLASH512, HW_NONE, 0x801353A, false },
70
71 // Koro Koro Puzzle - Happy Panechu!
72 { "KHPJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
73
74 // Legendz - Yomigaeru Shiren no Shima
75 { "BLJJ", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
76 { "BLJK", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
77
78 // Legendz - Sign of Nekuromu
79 { "BLVJ", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
80
81 // Mega Man Battle Network
82 { "AREE", SAVEDATA_SRAM, HW_NONE, 0x800032E, false },
83
84 // Mega Man Zero
85 { "AZCE", SAVEDATA_SRAM, HW_NONE, 0x80004E8, false },
86
87 // Metal Slug Advance
88 { "BSME", SAVEDATA_EEPROM, HW_NONE, 0x8000290, false },
89
90 // Pokemon Ruby
91 { "AXVJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
92 { "AXVE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
93 { "AXVP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
94 { "AXVI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
95 { "AXVS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
96 { "AXVD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
97 { "AXVF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
98
99 // Pokemon Sapphire
100 { "AXPJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
101 { "AXPE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
102 { "AXPP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
103 { "AXPI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
104 { "AXPS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
105 { "AXPD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
106 { "AXPF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
107
108 // Pokemon Emerald
109 { "BPEJ", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
110 { "BPEE", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
111 { "BPEP", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
112 { "BPEI", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
113 { "BPES", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
114 { "BPED", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
115 { "BPEF", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
116
117 // Pokemon Mystery Dungeon
118 { "B24J", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
119 { "B24E", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
120 { "B24P", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
121 { "B24U", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
122
123 // Pokemon FireRed
124 { "BPRJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
125 { "BPRE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
126 { "BPRP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
127 { "BPRI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
128 { "BPRS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
129 { "BPRD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
130 { "BPRF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
131
132 // Pokemon LeafGreen
133 { "BPGJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
134 { "BPGE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
135 { "BPGP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
136 { "BPGI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
137 { "BPGS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
138 { "BPGD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
139 { "BPGF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
140
141 // RockMan EXE 4.5 - Real Operation
142 { "BR4J", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
143
144 // Rocky
145 { "AR8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
146 { "AROP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
147
148 // Sennen Kazoku
149 { "BKAJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
150
151 // Shin Bokura no Taiyou: Gyakushuu no Sabata
152 { "U33J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
153
154 // Super Mario Advance 2
155 { "AA2J", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
156 { "AA2E", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
157 { "AA2P", SAVEDATA_AUTODETECT, HW_NONE, 0x800052E, false },
158
159 // Super Mario Advance 3
160 { "A3AJ", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
161 { "A3AE", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
162 { "A3AP", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
163
164 // Super Mario Advance 4
165 { "AX4J", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
166 { "AX4E", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
167 { "AX4P", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
168
169 // Super Monkey Ball Jr.
170 { "ALUE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
171 { "ALUP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
172
173 // Top Gun - Combat Zones
174 { "A2YE", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
175
176 // Ueki no Housoku - Jingi Sakuretsu! Nouryokusha Battle
177 { "BUHJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
178
179 // Wario Ware Twisted
180 { "RZWJ", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
181 { "RZWE", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
182 { "RZWP", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
183
184 // Yoshi's Universal Gravitation
185 { "KYGJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
186 { "KYGE", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
187 { "KYGP", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
188
189 // Aging cartridge
190 { "TCHK", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
191
192 // Famicom Mini series 3 (FDS), some aren't mirrored (22 - 28)
193 // See https://forum.no-intro.org/viewtopic.php?f=2&t=4221 for discussion
194 { "FNMJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
195 { "FMRJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
196 { "FPTJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
197 { "FLBJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
198 { "FFMJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
199 { "FTKJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
200 { "FTUJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
201
202 { { 0, 0, 0, 0 }, 0, 0, IDLE_LOOP_NONE, false }
203};
204
205bool GBAOverrideFind(const struct Configuration* config, struct GBACartridgeOverride* override) {
206 override->savetype = SAVEDATA_AUTODETECT;
207 override->hardware = HW_NONE;
208 override->idleLoop = IDLE_LOOP_NONE;
209 override->mirroring = false;
210 override->vbaBugCompat = false;
211 bool found = false;
212
213 int i;
214 for (i = 0; _overrides[i].id[0]; ++i) {
215 if (memcmp(override->id, _overrides[i].id, sizeof(override->id)) == 0) {
216 *override = _overrides[i];
217 found = true;
218 break;
219 }
220 }
221 if (!found && override->id[0] == 'F') {
222 // Classic NES Series
223 override->savetype = SAVEDATA_EEPROM;
224 override->mirroring = true;
225 found = true;
226 }
227
228 if (config) {
229 char sectionName[16];
230 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
231 const char* savetype = ConfigurationGetValue(config, sectionName, "savetype");
232 const char* hardware = ConfigurationGetValue(config, sectionName, "hardware");
233 const char* idleLoop = ConfigurationGetValue(config, sectionName, "idleLoop");
234
235 if (savetype) {
236 if (strcasecmp(savetype, "SRAM") == 0) {
237 found = true;
238 override->savetype = SAVEDATA_SRAM;
239 } else if (strcasecmp(savetype, "EEPROM") == 0) {
240 found = true;
241 override->savetype = SAVEDATA_EEPROM;
242 } else if (strcasecmp(savetype, "EEPROM512") == 0) {
243 found = true;
244 override->savetype = SAVEDATA_EEPROM512;
245 } else if (strcasecmp(savetype, "FLASH512") == 0) {
246 found = true;
247 override->savetype = SAVEDATA_FLASH512;
248 } else if (strcasecmp(savetype, "FLASH1M") == 0) {
249 found = true;
250 override->savetype = SAVEDATA_FLASH1M;
251 } else if (strcasecmp(savetype, "NONE") == 0) {
252 found = true;
253 override->savetype = SAVEDATA_FORCE_NONE;
254 }
255 }
256
257 if (hardware) {
258 char* end;
259 long type = strtoul(hardware, &end, 0);
260 if (end && !*end) {
261 override->hardware = type;
262 found = true;
263 }
264 }
265
266 if (idleLoop) {
267 char* end;
268 uint32_t address = strtoul(idleLoop, &end, 16);
269 if (end && !*end) {
270 override->idleLoop = address;
271 found = true;
272 }
273 }
274 }
275 return found;
276}
277
278void GBAOverrideSave(struct Configuration* config, const struct GBACartridgeOverride* override) {
279 char sectionName[16];
280 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
281 const char* savetype = 0;
282 switch (override->savetype) {
283 case SAVEDATA_SRAM:
284 savetype = "SRAM";
285 break;
286 case SAVEDATA_EEPROM:
287 savetype = "EEPROM";
288 break;
289 case SAVEDATA_EEPROM512:
290 savetype = "EEPROM512";
291 break;
292 case SAVEDATA_FLASH512:
293 savetype = "FLASH512";
294 break;
295 case SAVEDATA_FLASH1M:
296 savetype = "FLASH1M";
297 break;
298 case SAVEDATA_FORCE_NONE:
299 savetype = "NONE";
300 break;
301 case SAVEDATA_AUTODETECT:
302 break;
303 }
304 ConfigurationSetValue(config, sectionName, "savetype", savetype);
305
306 if (override->hardware != HW_NO_OVERRIDE) {
307 ConfigurationSetIntValue(config, sectionName, "hardware", override->hardware);
308 } else {
309 ConfigurationClearValue(config, sectionName, "hardware");
310 }
311
312 if (override->idleLoop != IDLE_LOOP_NONE) {
313 ConfigurationSetUIntValue(config, sectionName, "idleLoop", override->idleLoop);
314 } else {
315 ConfigurationClearValue(config, sectionName, "idleLoop");
316 }
317}
318
319void GBAOverrideApply(struct GBA* gba, const struct GBACartridgeOverride* override) {
320 if (override->savetype != SAVEDATA_AUTODETECT) {
321 GBASavedataForceType(&gba->memory.savedata, override->savetype);
322 }
323
324 gba->vbaBugCompat = override->vbaBugCompat;
325
326 if (override->hardware != HW_NO_OVERRIDE) {
327 GBAHardwareClear(&gba->memory.hw);
328
329 if (override->hardware & HW_RTC) {
330 GBAHardwareInitRTC(&gba->memory.hw);
331 }
332
333 if (override->hardware & HW_GYRO) {
334 GBAHardwareInitGyro(&gba->memory.hw);
335 }
336
337 if (override->hardware & HW_RUMBLE) {
338 GBAHardwareInitRumble(&gba->memory.hw);
339 }
340
341 if (override->hardware & HW_LIGHT_SENSOR) {
342 GBAHardwareInitLight(&gba->memory.hw);
343 }
344
345 if (override->hardware & HW_TILT) {
346 GBAHardwareInitTilt(&gba->memory.hw);
347 }
348
349 if (override->hardware & HW_EREADER) {
350 GBAHardwareInitEReader(&gba->memory.hw);
351 }
352
353 if (override->hardware & HW_GB_PLAYER_DETECTION) {
354 gba->memory.hw.devices |= HW_GB_PLAYER_DETECTION;
355 } else {
356 gba->memory.hw.devices &= ~HW_GB_PLAYER_DETECTION;
357 }
358 }
359
360 if (override->idleLoop != IDLE_LOOP_NONE) {
361 gba->idleLoop = override->idleLoop;
362 if (gba->idleOptimization == IDLE_LOOP_DETECT) {
363 gba->idleOptimization = IDLE_LOOP_REMOVE;
364 }
365 }
366
367 if (override->mirroring) {
368 gba->memory.mirroring = true;
369 }
370}
371
372void GBAOverrideApplyDefaults(struct GBA* gba, const struct Configuration* overrides) {
373 struct GBACartridgeOverride override = { .idleLoop = IDLE_LOOP_NONE };
374 const struct GBACartridge* cart = (const struct GBACartridge*) gba->memory.rom;
375 if (cart) {
376 memcpy(override.id, &cart->id, sizeof(override.id));
377
378 if (!strncmp("pokemon red version", &((const char*) gba->memory.rom)[0x108], 20) && gba->romCrc32 != 0xDD88761C) {
379 // Enable FLASH1M and RTC on Pokémon FireRed ROM hacks
380 override.savetype = SAVEDATA_FLASH1M;
381 override.hardware = HW_RTC;
382 override.vbaBugCompat = true;
383 GBAOverrideApply(gba, &override);
384 } else if (GBAOverrideFind(overrides, &override)) {
385 GBAOverrideApply(gba, &override);
386 }
387 }
388}