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 Pinball: Ruby & Sapphire
91 { "BPPJ", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
92 { "BPPE", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
93 { "BPPP", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
94 { "BPPU", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
95
96 // Pokemon Ruby
97 { "AXVJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
98 { "AXVE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
99 { "AXVP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
100 { "AXVI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
101 { "AXVS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
102 { "AXVD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
103 { "AXVF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
104
105 // Pokemon Sapphire
106 { "AXPJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
107 { "AXPE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
108 { "AXPP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
109 { "AXPI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
110 { "AXPS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
111 { "AXPD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
112 { "AXPF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
113
114 // Pokemon Emerald
115 { "BPEJ", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
116 { "BPEE", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
117 { "BPEP", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
118 { "BPEI", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
119 { "BPES", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
120 { "BPED", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
121 { "BPEF", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
122
123 // Pokemon Mystery Dungeon
124 { "B24J", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
125 { "B24E", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
126 { "B24P", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
127 { "B24U", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
128
129 // Pokemon FireRed
130 { "BPRJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
131 { "BPRE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
132 { "BPRP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
133 { "BPRI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
134 { "BPRS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
135 { "BPRD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
136 { "BPRF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
137
138 // Pokemon LeafGreen
139 { "BPGJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
140 { "BPGE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
141 { "BPGP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
142 { "BPGI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
143 { "BPGS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
144 { "BPGD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
145 { "BPGF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
146
147 // RockMan EXE 4.5 - Real Operation
148 { "BR4J", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
149
150 // Rocky
151 { "AR8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
152 { "AROP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
153
154 // Sennen Kazoku
155 { "BKAJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
156
157 // Shin Bokura no Taiyou: Gyakushuu no Sabata
158 { "U33J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
159
160 // Super Mario Advance 2
161 { "AA2J", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
162 { "AA2E", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
163 { "AA2P", SAVEDATA_AUTODETECT, HW_NONE, 0x800052E, false },
164
165 // Super Mario Advance 3
166 { "A3AJ", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
167 { "A3AE", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
168 { "A3AP", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
169
170 // Super Mario Advance 4
171 { "AX4J", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
172 { "AX4E", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
173 { "AX4P", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
174
175 // Super Monkey Ball Jr.
176 { "ALUE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
177 { "ALUP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
178
179 // Top Gun - Combat Zones
180 { "A2YE", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
181
182 // Ueki no Housoku - Jingi Sakuretsu! Nouryokusha Battle
183 { "BUHJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
184
185 // Wario Ware Twisted
186 { "RZWJ", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
187 { "RZWE", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
188 { "RZWP", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
189
190 // Yoshi's Universal Gravitation
191 { "KYGJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
192 { "KYGE", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
193 { "KYGP", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
194
195 // Aging cartridge
196 { "TCHK", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
197
198 { { 0, 0, 0, 0 }, 0, 0, IDLE_LOOP_NONE, false }
199};
200
201bool GBAOverrideFind(const struct Configuration* config, struct GBACartridgeOverride* override) {
202 override->savetype = SAVEDATA_AUTODETECT;
203 override->hardware = HW_NONE;
204 override->idleLoop = IDLE_LOOP_NONE;
205 override->mirroring = false;
206 bool found = false;
207
208 if (override->id[0] == 'F') {
209 // Classic NES Series
210 override->savetype = SAVEDATA_EEPROM;
211 override->mirroring = true;
212 found = true;
213 } else {
214 int i;
215 for (i = 0; _overrides[i].id[0]; ++i) {
216 if (memcmp(override->id, _overrides[i].id, sizeof(override->id)) == 0) {
217 *override = _overrides[i];
218 found = true;
219 break;
220 }
221 }
222 }
223
224 if (config) {
225 char sectionName[16];
226 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
227 const char* savetype = ConfigurationGetValue(config, sectionName, "savetype");
228 const char* hardware = ConfigurationGetValue(config, sectionName, "hardware");
229 const char* idleLoop = ConfigurationGetValue(config, sectionName, "idleLoop");
230
231 if (savetype) {
232 if (strcasecmp(savetype, "SRAM") == 0) {
233 found = true;
234 override->savetype = SAVEDATA_SRAM;
235 } else if (strcasecmp(savetype, "EEPROM") == 0) {
236 found = true;
237 override->savetype = SAVEDATA_EEPROM;
238 } else if (strcasecmp(savetype, "EEPROM512") == 0) {
239 found = true;
240 override->savetype = SAVEDATA_EEPROM512;
241 } else if (strcasecmp(savetype, "FLASH512") == 0) {
242 found = true;
243 override->savetype = SAVEDATA_FLASH512;
244 } else if (strcasecmp(savetype, "FLASH1M") == 0) {
245 found = true;
246 override->savetype = SAVEDATA_FLASH1M;
247 } else if (strcasecmp(savetype, "NONE") == 0) {
248 found = true;
249 override->savetype = SAVEDATA_FORCE_NONE;
250 }
251 }
252
253 if (hardware) {
254 char* end;
255 long type = strtoul(hardware, &end, 0);
256 if (end && !*end) {
257 override->hardware = type;
258 found = true;
259 }
260 }
261
262 if (idleLoop) {
263 char* end;
264 uint32_t address = strtoul(idleLoop, &end, 16);
265 if (end && !*end) {
266 override->idleLoop = address;
267 found = true;
268 }
269 }
270 }
271 return found;
272}
273
274void GBAOverrideSave(struct Configuration* config, const struct GBACartridgeOverride* override) {
275 char sectionName[16];
276 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
277 const char* savetype = 0;
278 switch (override->savetype) {
279 case SAVEDATA_SRAM:
280 savetype = "SRAM";
281 break;
282 case SAVEDATA_EEPROM:
283 savetype = "EEPROM";
284 break;
285 case SAVEDATA_EEPROM512:
286 savetype = "EEPROM512";
287 break;
288 case SAVEDATA_FLASH512:
289 savetype = "FLASH512";
290 break;
291 case SAVEDATA_FLASH1M:
292 savetype = "FLASH1M";
293 break;
294 case SAVEDATA_FORCE_NONE:
295 savetype = "NONE";
296 break;
297 case SAVEDATA_AUTODETECT:
298 break;
299 }
300 ConfigurationSetValue(config, sectionName, "savetype", savetype);
301
302 if (override->hardware != HW_NO_OVERRIDE) {
303 ConfigurationSetIntValue(config, sectionName, "hardware", override->hardware);
304 } else {
305 ConfigurationClearValue(config, sectionName, "hardware");
306 }
307
308 if (override->idleLoop != IDLE_LOOP_NONE) {
309 ConfigurationSetUIntValue(config, sectionName, "idleLoop", override->idleLoop);
310 } else {
311 ConfigurationClearValue(config, sectionName, "idleLoop");
312 }
313}
314
315void GBAOverrideApply(struct GBA* gba, const struct GBACartridgeOverride* override) {
316 if (override->savetype != SAVEDATA_AUTODETECT) {
317 GBASavedataForceType(&gba->memory.savedata, override->savetype);
318 }
319
320 if (override->hardware != HW_NO_OVERRIDE) {
321 GBAHardwareClear(&gba->memory.hw);
322
323 if (override->hardware & HW_RTC) {
324 GBAHardwareInitRTC(&gba->memory.hw);
325 }
326
327 if (override->hardware & HW_GYRO) {
328 GBAHardwareInitGyro(&gba->memory.hw);
329 }
330
331 if (override->hardware & HW_RUMBLE) {
332 GBAHardwareInitRumble(&gba->memory.hw);
333 }
334
335 if (override->hardware & HW_LIGHT_SENSOR) {
336 GBAHardwareInitLight(&gba->memory.hw);
337 }
338
339 if (override->hardware & HW_TILT) {
340 GBAHardwareInitTilt(&gba->memory.hw);
341 }
342
343 if (override->hardware & HW_EREADER) {
344 GBAHardwareInitEReader(&gba->memory.hw);
345 }
346
347 if (override->hardware & HW_GB_PLAYER_DETECTION) {
348 gba->memory.hw.devices |= HW_GB_PLAYER_DETECTION;
349 } else {
350 gba->memory.hw.devices &= ~HW_GB_PLAYER_DETECTION;
351 }
352 }
353
354 if (override->idleLoop != IDLE_LOOP_NONE) {
355 gba->idleLoop = override->idleLoop;
356 if (gba->idleOptimization == IDLE_LOOP_DETECT) {
357 gba->idleOptimization = IDLE_LOOP_REMOVE;
358 }
359 }
360
361 if (override->mirroring) {
362 gba->memory.mirroring = true;
363 }
364}
365
366void GBAOverrideApplyDefaults(struct GBA* gba, const struct Configuration* overrides) {
367 struct GBACartridgeOverride override = { .idleLoop = IDLE_LOOP_NONE };
368 const struct GBACartridge* cart = (const struct GBACartridge*) gba->memory.rom;
369 if (cart) {
370 memcpy(override.id, &cart->id, sizeof(override.id));
371
372 if (!strncmp("pokemon red version", &((const char*) gba->memory.rom)[0x108], 20) && gba->romCrc32 != 0xDD88761C) {
373 // Enable FLASH1M and RTC on Pokémon FireRed ROM hacks
374 override.savetype = SAVEDATA_FLASH1M;
375 override.hardware = HW_RTC;
376 GBAOverrideApply(gba, &override);
377 } else if (GBAOverrideFind(overrides, &override)) {
378 GBAOverrideApply(gba, &override);
379 }
380 }
381}