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